site/javadoc/r1.2.0/org/apache/edgent/topology/spi/graph/GraphTopology.html - incubator-retired-edgent-website - Git at Google

 <!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>GraphTopology (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="GraphTopology (Apache Edgent (incubating) v1.2.0 API)";
         }
     }
     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/GraphTopology.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/topology/spi/graph/ConnectorStream.html" title="class in org.apache.edgent.topology.spi.graph"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../../org/apache/edgent/topology/spi/graph/TWindowImpl.html" title="class in org.apache.edgent.topology.spi.graph"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/edgent/topology/spi/graph/GraphTopology.html" target="_top">Frames</a></li>
 <li><a href="GraphTopology.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.topology.spi.graph</div>
 <h2 title="Class GraphTopology" class="title">Class GraphTopology&lt;X extends <a href="../../../../../../org/apache/edgent/topology/tester/Tester.html" title="interface in org.apache.edgent.topology.tester">Tester</a>&gt;</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
 <li>
 <ul class="inheritance">
 <li><a href="../../../../../../org/apache/edgent/topology/spi/AbstractTopology.html" title="class in org.apache.edgent.topology.spi">org.apache.edgent.topology.spi.AbstractTopology</a>&lt;X&gt;</li>
 <li>
 <ul class="inheritance">
 <li>org.apache.edgent.topology.spi.graph.GraphTopology&lt;X&gt;</li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>X</code> - Tester type</dd>
 </dl>
 <dl>
 <dt>All Implemented Interfaces:</dt>
 <dd><a href="../../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>, <a href="../../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></dd>
 </dl>
 <dl>
 <dt>Direct Known Subclasses:</dt>
 <dd><a href="../../../../../../org/apache/edgent/providers/direct/DirectTopology.html" title="class in org.apache.edgent.providers.direct">DirectTopology</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public abstract class <span class="typeNameLabel">GraphTopology&lt;X extends <a href="../../../../../../org/apache/edgent/topology/tester/Tester.html" title="interface in org.apache.edgent.topology.tester">Tester</a>&gt;</span>
 extends <a href="../../../../../../org/apache/edgent/topology/spi/AbstractTopology.html" title="class in org.apache.edgent.topology.spi">AbstractTopology</a>&lt;X&gt;</pre>
 <div class="block">Topology implementation that provides basic functions for implementing
  source streams backed by a <a href="../../../../../../org/apache/edgent/graph/Graph.html" title="interface in org.apache.edgent.graph"><code>Graph</code></a>.</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="colFirst" scope="col">Modifier</th>
 <th class="colLast" scope="col">Constructor and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected </code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/topology/spi/graph/GraphTopology.html#GraphTopology-java.lang.String-">GraphTopology</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;name)</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>&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/spi/graph/GraphTopology.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="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/spi/graph/GraphTopology.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="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/spi/graph/GraphTopology.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="i3" class="rowColor">
 <td class="colFirst"><code>protected &lt;N extends <a href="../../../../../../org/apache/edgent/oplet/core/Source.html" title="class in org.apache.edgent.oplet.core">Source</a>&lt;T&gt;,T&gt;<br><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/spi/graph/GraphTopology.html#sourceStream-N-">sourceStream</a></span>(N&nbsp;sourceOp)</code>&nbsp;</td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.org.apache.edgent.topology.spi.AbstractTopology">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.apache.edgent.topology.spi.<a href="../../../../../../org/apache/edgent/topology/spi/AbstractTopology.html" title="class in org.apache.edgent.topology.spi">AbstractTopology</a></h3>
 <code><a href="../../../../../../org/apache/edgent/topology/spi/AbstractTopology.html#collection-java.util.Collection-">collection</a>, <a href="../../../../../../org/apache/edgent/topology/spi/AbstractTopology.html#generate-org.apache.edgent.function.Supplier-">generate</a>, <a href="../../../../../../org/apache/edgent/topology/spi/AbstractTopology.html#getName--">getName</a>, <a href="../../../../../../org/apache/edgent/topology/spi/AbstractTopology.html#getTester--">getTester</a>, <a href="../../../../../../org/apache/edgent/topology/spi/AbstractTopology.html#newTester--">newTester</a>, <a href="../../../../../../org/apache/edgent/topology/spi/AbstractTopology.html#of-T...-">of</a>, <a href="../../../../../../org/apache/edgent/topology/spi/AbstractTopology.html#strings-java.lang.String...-">strings</a>, <a href="../../../../../../org/apache/edgent/topology/spi/AbstractTopology.html#topology--">topology</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.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
 <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.org.apache.edgent.topology.Topology">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.apache.edgent.topology.<a href="../../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a></h3>
 <code><a href="../../../../../../org/apache/edgent/topology/Topology.html#getRuntimeServiceSupplier--">getRuntimeServiceSupplier</a>, <a href="../../../../../../org/apache/edgent/topology/Topology.html#graph--">graph</a></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="GraphTopology-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>GraphTopology</h4>
 <pre>protected&nbsp;GraphTopology(<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;name)</pre>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="sourceStream-org.apache.edgent.oplet.core.Source-">
 <!--   -->
 </a><a name="sourceStream-N-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>sourceStream</h4>
 <pre>protected&nbsp;&lt;N extends <a href="../../../../../../org/apache/edgent/oplet/core/Source.html" title="class in org.apache.edgent.oplet.core">Source</a>&lt;T&gt;,T&gt;&nbsp;<a href="../../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;&nbsp;sourceStream(N&nbsp;sourceOp)</pre>
 </li>
 </ul>
 <a name="source-org.apache.edgent.function.Supplier-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>source</h4>
 <pre>public&nbsp;&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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/edgent/topology/Topology.html#source-org.apache.edgent.function.Supplier-">Topology</a></code></span></div>
 <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="poll-org.apache.edgent.function.Supplier-long-java.util.concurrent.TimeUnit-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>poll</h4>
 <pre>public&nbsp;&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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/edgent/topology/Topology.html#poll-org.apache.edgent.function.Supplier-long-java.util.concurrent.TimeUnit-">Topology</a></code></span></div>
 <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="blockListLast">
 <li class="blockList">
 <h4>events</h4>
 <pre>public&nbsp;&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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/edgent/topology/Topology.html#events-org.apache.edgent.function.Consumer-">Topology</a></code></span></div>
 <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>
 </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/GraphTopology.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/topology/spi/graph/ConnectorStream.html" title="class in org.apache.edgent.topology.spi.graph"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../../org/apache/edgent/topology/spi/graph/TWindowImpl.html" title="class in org.apache.edgent.topology.spi.graph"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/edgent/topology/spi/graph/GraphTopology.html" target="_top">Frames</a></li>
 <li><a href="GraphTopology.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&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </body>
 </html>