blob: 0cb6b01e2a0dc3ae12ac6fc5446a2bda10aa60fe [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:19 EST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Topology (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="Topology (Apache Edgent (incubating) v1.2.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Topology.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/topology/TopologyElement.html" title="interface in org.apache.edgent.topology"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/edgent/topology/Topology.html" target="_top">Frames</a></li>
<li><a href="Topology.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>Constr&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>Constr&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.topology</div>
<h2 title="Interface Topology" class="title">Interface Topology</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/edgent/topology/spi/AbstractTopology.html" title="class in org.apache.edgent.topology.spi">AbstractTopology</a>, <a href="../../../../org/apache/edgent/providers/direct/DirectTopology.html" title="class in org.apache.edgent.providers.direct">DirectTopology</a>, <a href="../../../../org/apache/edgent/topology/spi/graph/GraphTopology.html" title="class in org.apache.edgent.topology.spi.graph">GraphTopology</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Topology</span>
extends <a href="../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></pre>
<div class="block">A declaration of a topology of streaming data.
This class provides some fundamental generic methods to create source
streams, such as <a href="../../../../org/apache/edgent/topology/Topology.html#source-org.apache.edgent.function.Supplier-"><code>source</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>,
<a href="../../../../org/apache/edgent/topology/Topology.html#strings-java.lang.String...-"><code>strings</code></a>.
<P>
See <a href="doc-files/sources.html">Edgent Source Streams</a>.
</P></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>&lt;T&gt;&nbsp;<a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/Topology.html#collection-java.util.Collection-">collection</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;T&gt;&nbsp;tuples)</code>
<div class="block">Declare a stream of constants from a collection.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/Topology.html#events-org.apache.edgent.function.Consumer-">events</a></span>(<a href="../../../../org/apache/edgent/function/Consumer.html" title="interface in org.apache.edgent.function">Consumer</a>&lt;<a href="../../../../org/apache/edgent/function/Consumer.html" title="interface in org.apache.edgent.function">Consumer</a>&lt;T&gt;&gt;&nbsp;eventSetup)</code>
<div class="block">Declare a stream populated by an event system.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/Topology.html#generate-org.apache.edgent.function.Supplier-">generate</a></span>(<a href="../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a>&lt;T&gt;&nbsp;data)</code>
<div class="block">Declare an endless source stream.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/Topology.html#getName--">getName</a></span>()</code>
<div class="block">Name of this topology.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a>&lt;<a href="../../../../org/apache/edgent/execution/services/RuntimeServices.html" title="interface in org.apache.edgent.execution.services">RuntimeServices</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/Topology.html#getRuntimeServiceSupplier--">getRuntimeServiceSupplier</a></span>()</code>
<div class="block">Return a function that at execution time
will return a <a href="../../../../org/apache/edgent/execution/services/RuntimeServices.html" title="interface in org.apache.edgent.execution.services"><code>RuntimeServices</code></a> instance
a stream function can use.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/edgent/topology/tester/Tester.html" title="interface in org.apache.edgent.topology.tester">Tester</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/Topology.html#getTester--">getTester</a></span>()</code>
<div class="block">Get the tester for this topology.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/edgent/graph/Graph.html" title="interface in org.apache.edgent.graph">Graph</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/Topology.html#graph--">graph</a></span>()</code>
<div class="block">Get the underlying graph.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/Topology.html#of-T...-">of</a></span>(T...&nbsp;values)</code>
<div class="block">Declare a stream of objects.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/Topology.html#poll-org.apache.edgent.function.Supplier-long-java.util.concurrent.TimeUnit-">poll</a></span>(<a href="../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a>&lt;T&gt;&nbsp;data,
long&nbsp;period,
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)</code>
<div class="block">Declare a new source stream that calls <code>data.get()</code> periodically.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/Topology.html#source-org.apache.edgent.function.Supplier-">source</a></span>(<a href="../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;T&gt;&gt;&nbsp;data)</code>
<div class="block">Declare a new source stream that iterates over the return of
<code>Iterable&lt;T&gt; get()</code> from <code>data</code>.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/Topology.html#strings-java.lang.String...-">strings</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;strings)</code>
<div class="block">Declare a stream of strings.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.edgent.topology.TopologyElement">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.edgent.topology.<a href="../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></h3>
<code><a href="../../../../org/apache/edgent/topology/TopologyElement.html#topology--">topology</a></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="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">Name of this topology.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Name of this topology.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/edgent/topology/TopologyProvider.html#newTopology-java.lang.String-"><code>TopologyProvider.newTopology(String)</code></a></dd>
</dl>
</li>
</ul>
<a name="source-org.apache.edgent.function.Supplier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>source</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;&nbsp;source(<a href="../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;T&gt;&gt;&nbsp;data)</pre>
<div class="block">Declare a new source stream that iterates over the return of
<code>Iterable&lt;T&gt; get()</code> from <code>data</code>. Once all the tuples from
<code>data.get()</code> have been submitted on the stream, no more tuples are
submitted. <BR>
The returned stream will be endless if the iterator returned from the
<code>Iterable</code> never completes.
<p>
If <code>data</code> implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang"><code>AutoCloseable</code></a>, its <code>close()</code>
method will be called when the topology's execution is terminated.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Tuple type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - Function that produces that data for the stream.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>New stream containing the tuples from the iterator returned by
<code>data.get()</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="doc-files/sources.html">Edgent Source Streams</a></dd>
</dl>
</li>
</ul>
<a name="generate-org.apache.edgent.function.Supplier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generate</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;&nbsp;generate(<a href="../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a>&lt;T&gt;&nbsp;data)</pre>
<div class="block">Declare an endless source stream. <code>data.get()</code> will be called
repeatably. Each non-null returned value will be present on the stream.
<p>
If <code>data</code> implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang"><code>AutoCloseable</code></a>, its <code>close()</code>
method will be called when the topology's execution is terminated.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Tuple type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - Supplier of the tuples.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>New stream containing the tuples from calls to <code>data.get()</code>
.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="doc-files/sources.html">Edgent Source Streams</a></dd>
</dl>
</li>
</ul>
<a name="poll-org.apache.edgent.function.Supplier-long-java.util.concurrent.TimeUnit-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>poll</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;&nbsp;poll(<a href="../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a>&lt;T&gt;&nbsp;data,
long&nbsp;period,
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)</pre>
<div class="block">Declare a new source stream that calls <code>data.get()</code> periodically.
Each non-null value returned will appear on the returned stream. Thus
each call to {code data.get()} will result in zero tuples or one tuple on
the stream.
<p>
If <code>data</code> implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang"><code>AutoCloseable</code></a>, its <code>close()</code>
method will be called when the topology's execution is terminated.
</p><p>
The poll rate may be changed when the topology is running via a runtime
<a href="../../../../org/apache/edgent/execution/mbeans/PeriodMXBean.html" title="interface in org.apache.edgent.execution.mbeans"><code>PeriodMXBean</code></a>.
In order to use this mechanism the caller must provide a
alias for the stream when building the topology.
The <code>PeriodMXBean</code> is registered with the <a href="../../../../org/apache/edgent/execution/services/ControlService.html" title="interface in org.apache.edgent.execution.services"><code>ControlService</code></a>
with type <a href="../../../../org/apache/edgent/topology/TStream.html#TYPE"><code>TStream.TYPE</code></a> and the stream's alias.
e.g.,
</p>
<pre><code>
Topology t = ...
TStream&lt;Integer&gt; stream = t.poll(...).alias("myStreamControlAlias");
// change the poll frequency at runtime
static &lt;T&gt; void setPollFrequency(TStream&lt;T&gt; pollStream, long period, TimeUnit unit) {
ControlService cs = t.getRuntimeServiceSupplier().getService(ControlService.class);
String alias = pollStream.getAlias();
PeriodMXBean control = cs.getControl(TStream.TYPE, alias, PeriodMXBean.class);
control.setPoll(period, unit);
}
</code></pre></div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Tuple type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - Function that produces that data for the stream.</dd>
<dd><code>period</code> - Approximate period {code data.get()} will be called.</dd>
<dd><code>unit</code> - Time unit of <code>period</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>New stream containing the tuples returned by <code>data.get()</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="doc-files/sources.html">Edgent Source Streams</a></dd>
</dl>
</li>
</ul>
<a name="events-org.apache.edgent.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>events</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;&nbsp;events(<a href="../../../../org/apache/edgent/function/Consumer.html" title="interface in org.apache.edgent.function">Consumer</a>&lt;<a href="../../../../org/apache/edgent/function/Consumer.html" title="interface in org.apache.edgent.function">Consumer</a>&lt;T&gt;&gt;&nbsp;eventSetup)</pre>
<div class="block">Declare a stream populated by an event system. At startup
<code>eventSetup.accept(eventSubmitter))</code> is called by the runtime with
<code>eventSubmitter</code> being a <code>Consumer&lt;T&gt;</code>. Calling
<code>eventSubmitter.accept(t)</code> results in <code>t</code> being present on
the returned stream if it is not null. If <code>t</code> is null then no
action is taken. <BR>
It is expected that <code>eventSubmitter</code> is called from the event
handler callback registered with the event system.
<P>
Downstream processing is isolated from the event source
to ensure that event listener is not blocked by a long
or slow processing flow.
</P>
<p>
If <code>eventSetup</code> implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang"><code>AutoCloseable</code></a>, its <code>close()</code>
method will be called when the topology's execution is terminated.
</P></div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Tuple type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>eventSetup</code> - handler to receive the <code>eventSubmitter</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>New stream containing the tuples added by <code>eventSubmitter.accept(t)</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/edgent/topology/plumbing/PlumbingStreams.html#pressureReliever-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-int-"><code>PlumbingStreams.pressureReliever(TStream, org.apache.edgent.function.Function, int)</code></a>,
<a href="doc-files/sources.html">Edgent Source Streams</a></dd>
</dl>
</li>
</ul>
<a name="strings-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>strings</h4>
<pre><a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;strings(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;strings)</pre>
<div class="block">Declare a stream of strings.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>strings</code> - Strings that will be present on the stream.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Stream containing all values in <code>strings</code>.</dd>
</dl>
</li>
</ul>
<a name="of-java.lang.Object:A-">
<!-- -->
</a><a name="of-T...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;&nbsp;of(T...&nbsp;values)</pre>
<div class="block">Declare a stream of objects.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Tuple type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - Values that will be present on the stream.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Stream containing all values in <code>values</code>.</dd>
</dl>
</li>
</ul>
<a name="collection-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collection</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;&nbsp;collection(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;T&gt;&nbsp;tuples)</pre>
<div class="block">Declare a stream of constants from a collection.
The returned stream will contain all the tuples in <code>tuples</code>.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Tuple type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tuples</code> - Tuples that will be present on the stream.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Stream containing all values in <code>tuples</code>.</dd>
</dl>
</li>
</ul>
<a name="getTester--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTester</h4>
<pre><a href="../../../../org/apache/edgent/topology/tester/Tester.html" title="interface in org.apache.edgent.topology.tester">Tester</a>&nbsp;getTester()</pre>
<div class="block">Get the tester for this topology.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>tester for this topology.</dd>
</dl>
</li>
</ul>
<a name="graph--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>graph</h4>
<pre><a href="../../../../org/apache/edgent/graph/Graph.html" title="interface in org.apache.edgent.graph">Graph</a>&nbsp;graph()</pre>
<div class="block">Get the underlying graph.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the underlying graph.</dd>
</dl>
</li>
</ul>
<a name="getRuntimeServiceSupplier--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRuntimeServiceSupplier</h4>
<pre><a href="../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a>&lt;<a href="../../../../org/apache/edgent/execution/services/RuntimeServices.html" title="interface in org.apache.edgent.execution.services">RuntimeServices</a>&gt;&nbsp;getRuntimeServiceSupplier()</pre>
<div class="block">Return a function that at execution time
will return a <a href="../../../../org/apache/edgent/execution/services/RuntimeServices.html" title="interface in org.apache.edgent.execution.services"><code>RuntimeServices</code></a> instance
a stream function can use.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Function that at execution time
will return a <a href="../../../../org/apache/edgent/execution/services/RuntimeServices.html" title="interface in org.apache.edgent.execution.services"><code>RuntimeServices</code></a> instance</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/Topology.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/topology/TopologyElement.html" title="interface in org.apache.edgent.topology"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/edgent/topology/Topology.html" target="_top">Frames</a></li>
<li><a href="Topology.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>Constr&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>Constr&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&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>