Google Git
Sign in
apache / incubator-retired-edgent-website / 7cee56122ea6c7f52d4cf28ce877cdc3466aa530 / . / site / javadoc / r1.0.0 / org / apache / edgent / providers / direct / DirectProvider.html
blob: a2cd39463f5565313a8d91ce6f72236c8dfce19d [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_77) on Mon Oct 24 00:05:43 UTC 2016 -->
<title>DirectProvider (Edgent v1.0.0)</title>
<meta name="date" content="2016-10-24">
<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="DirectProvider (Edgent v1.0.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":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/DirectProvider.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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/edgent/providers/direct/DirectTopology.html" title="class in org.apache.edgent.providers.direct"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/edgent/providers/direct/DirectProvider.html" target="_top">Frames</a></li>
<li><a href="DirectProvider.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.providers.direct</div>
<h2 title="Class DirectProvider" class="title">Class DirectProvider</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/edgent/topology/spi/AbstractTopologyProvider.html" title="class in org.apache.edgent.topology.spi">org.apache.edgent.topology.spi.AbstractTopologyProvider</a>&lt;<a href="../../../../../org/apache/edgent/providers/direct/DirectTopology.html" title="class in org.apache.edgent.providers.direct">DirectTopology</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.edgent.providers.direct.DirectProvider</li>
</ul>
</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/DirectSubmitter.html" title="interface in org.apache.edgent.execution">DirectSubmitter</a>&lt;<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>&gt;, <a href="../../../../../org/apache/edgent/execution/Submitter.html" title="interface in org.apache.edgent.execution">Submitter</a>&lt;<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>&gt;, <a href="../../../../../org/apache/edgent/topology/TopologyProvider.html" title="interface in org.apache.edgent.topology">TopologyProvider</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/edgent/providers/development/DevelopmentProvider.html" title="class in org.apache.edgent.providers.development">DevelopmentProvider</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">DirectProvider</span>
extends <a href="../../../../../org/apache/edgent/topology/spi/AbstractTopologyProvider.html" title="class in org.apache.edgent.topology.spi">AbstractTopologyProvider</a>&lt;<a href="../../../../../org/apache/edgent/providers/direct/DirectTopology.html" title="class in org.apache.edgent.providers.direct">DirectTopology</a>&gt;
implements <a href="../../../../../org/apache/edgent/execution/DirectSubmitter.html" title="interface in org.apache.edgent.execution">DirectSubmitter</a>&lt;<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>&gt;</pre>
<div class="block"><code>DirectProvider</code> is a <a href="../../../../../org/apache/edgent/topology/TopologyProvider.html" title="interface in org.apache.edgent.topology"><code>TopologyProvider</code></a> that
runs a submitted topology as a <a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution"><code>Job</code></a> in threads
in the current virtual machine.
<P>
A job (execution of a topology) continues to execute
while any of its elements have remaining work,
such as any of the topology's source streams are capable
of generating tuples.
<BR>
"Endless" source streams never terminate - e.g., a stream
created by <a href="../../../../../org/apache/edgent/topology/Topology.html#generate-org.apache.edgent.function.Supplier-"><code>generate()</code></a>,
<a href="../../../../../org/apache/edgent/topology/Topology.html#poll-org.apache.edgent.function.Supplier-long-java.util.concurrent.TimeUnit-"><code>poll()</code></a>,
or <a href="../../../../../org/apache/edgent/topology/Topology.html#events-org.apache.edgent.function.Consumer-"><code>events()</code></a>.
Hence a job with such sources runs until either it or some other
entity terminates it.
</P></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">&nbsp;</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/providers/direct/DirectProvider.html#DirectProvider--">DirectProvider</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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><a href="../../../../../org/apache/edgent/execution/services/ServiceContainer.html" title="class in org.apache.edgent.execution.services">ServiceContainer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/direct/DirectProvider.html#getServices--">getServices</a></span>()</code>
<div class="block">Access to services.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/edgent/providers/direct/DirectTopology.html" title="class in org.apache.edgent.providers.direct">DirectTopology</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/direct/DirectProvider.html#newTopology-java.lang.String-">newTopology</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Create a new topology with a given name.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.concurrent.Future&lt;<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/direct/DirectProvider.html#submit-org.apache.edgent.topology.Topology-">submit</a></span>(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>&nbsp;topology)</code>
<div class="block">Submit an executable.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.concurrent.Future&lt;<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/direct/DirectProvider.html#submit-org.apache.edgent.topology.Topology-com.google.gson.JsonObject-">submit</a></span>(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>&nbsp;topology,
com.google.gson.JsonObject&nbsp;config)</code>
<div class="block">Submit an executable.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.edgent.topology.spi.AbstractTopologyProvider">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.edgent.topology.spi.<a href="../../../../../org/apache/edgent/topology/spi/AbstractTopologyProvider.html" title="class in org.apache.edgent.topology.spi">AbstractTopologyProvider</a></h3>
<code><a href="../../../../../org/apache/edgent/topology/spi/AbstractTopologyProvider.html#newTopology--">newTopology</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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="DirectProvider--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DirectProvider</h4>
<pre>public&nbsp;DirectProvider()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getServices--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServices</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/edgent/execution/services/ServiceContainer.html" title="class in org.apache.edgent.execution.services">ServiceContainer</a>&nbsp;getServices()</pre>
<div class="block">Access to services.
Since any executables are executed directly within
the current virtual machine, callers may register
services that are visible to the executable
and its elements.
<P>
The returned services instance is shared
across all jobs submitted to this provider.
</P></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/edgent/execution/DirectSubmitter.html#getServices--">getServices</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/edgent/execution/DirectSubmitter.html" title="interface in org.apache.edgent.execution">DirectSubmitter</a>&lt;<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Service container for this submitter.</dd>
</dl>
</li>
</ul>
<a name="newTopology-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newTopology</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/edgent/providers/direct/DirectTopology.html" title="class in org.apache.edgent.providers.direct">DirectTopology</a>&nbsp;newTopology(java.lang.String&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/edgent/topology/TopologyProvider.html#newTopology-java.lang.String-">TopologyProvider</a></code></span></div>
<div class="block">Create a new topology with a given name.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/edgent/topology/TopologyProvider.html#newTopology-java.lang.String-">newTopology</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/edgent/topology/TopologyProvider.html" title="interface in org.apache.edgent.topology">TopologyProvider</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/edgent/topology/spi/AbstractTopologyProvider.html#newTopology-java.lang.String-">newTopology</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/edgent/topology/spi/AbstractTopologyProvider.html" title="class in org.apache.edgent.topology.spi">AbstractTopologyProvider</a>&lt;<a href="../../../../../org/apache/edgent/providers/direct/DirectTopology.html" title="class in org.apache.edgent.providers.direct">DirectTopology</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name for topology</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new topology.</dd>
</dl>
</li>
</ul>
<a name="submit-org.apache.edgent.topology.Topology-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>submit</h4>
<pre>public&nbsp;java.util.concurrent.Future&lt;<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>&gt;&nbsp;submit(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>&nbsp;topology)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/edgent/execution/Submitter.html#submit-E-">Submitter</a></code></span></div>
<div class="block">Submit an executable.
No configuration options are specified,
this is equivalent to <code>submit(executable, new JsonObject())</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/edgent/execution/Submitter.html#submit-E-">submit</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/edgent/execution/Submitter.html" title="interface in org.apache.edgent.execution">Submitter</a>&lt;<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>topology</code> - executable to submit</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a future for the submitted executable</dd>
</dl>
</li>
</ul>
<a name="submit-org.apache.edgent.topology.Topology-com.google.gson.JsonObject-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>submit</h4>
<pre>public&nbsp;java.util.concurrent.Future&lt;<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>&gt;&nbsp;submit(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>&nbsp;topology,
com.google.gson.JsonObject&nbsp;config)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/edgent/execution/Submitter.html#submit-E-com.google.gson.JsonObject-">Submitter</a></code></span></div>
<div class="block">Submit an executable.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/edgent/execution/Submitter.html#submit-E-com.google.gson.JsonObject-">submit</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/edgent/execution/Submitter.html" title="interface in org.apache.edgent.execution">Submitter</a>&lt;<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>topology</code> - executable to submit</dd>
<dd><code>config</code> - context <a href="../../../../../org/apache/edgent/execution/Configs.html" title="interface in org.apache.edgent.execution">information</a> for the submission</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a future for the submitted executable</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>
<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/DirectProvider.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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/edgent/providers/direct/DirectTopology.html" title="class in org.apache.edgent.providers.direct"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/edgent/providers/direct/DirectProvider.html" target="_top">Frames</a></li>
<li><a href="DirectProvider.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2016 The Apache Software Foundation. All Rights Reserved - 59dfbdf-20161024-0005</small></p>
</body>
</html>