| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>OutgoingTupleCollection (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-03-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="OutgoingTupleCollection (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.heron.instance</a></div> |
| <h2 title="Class OutgoingTupleCollection" class="title">Class OutgoingTupleCollection</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.instance.OutgoingTupleCollection</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">OutgoingTupleCollection</span> |
| extends java.lang.Object</pre> |
| <div class="block">Implements OutgoingTupleCollection will be able to handle some basic methods for send out tuples |
| 1. initNewControlTuple or initNewDataTuple |
| 2. addDataTuple, addAckTuple and addFailTuple |
| 3. flushRemaining tuples and sent out the tuples |
| <p> |
| In fact, when talking about to send out tuples, we mean we push them to the out queues.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../common/utils/misc/PhysicalPlanHelper.html" title="class in org.apache.heron.common.utils.misc">PhysicalPlanHelper</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#helper">helper</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../common/utils/metrics/ComponentMetrics.html" title="interface in org.apache.heron.common.utils.metrics">ComponentMetrics</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#metrics">metrics</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.heron.common.utils.misc.PhysicalPlanHelper,org.apache.heron.common.basics.Communicator,java.util.concurrent.locks.ReentrantLock,org.apache.heron.common.utils.metrics.ComponentMetrics)">OutgoingTupleCollection</a></span>​(<a href="../common/utils/misc/PhysicalPlanHelper.html" title="class in org.apache.heron.common.utils.misc">PhysicalPlanHelper</a> helper, |
| <a href="../common/basics/Communicator.html" title="class in org.apache.heron.common.basics">Communicator</a><com.google.protobuf.Message> outQueue, |
| java.util.concurrent.locks.ReentrantLock lock, |
| <a href="../common/utils/metrics/ComponentMetrics.html" title="interface in org.apache.heron.common.utils.metrics">ComponentMetrics</a> metrics)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addAckTuple(org.apache.heron.proto.system.HeronTuples.AckTuple.Builder,long)">addAckTuple</a></span>​(<a href="../proto/system/HeronTuples.AckTuple.Builder.html" title="class in org.apache.heron.proto.system">HeronTuples.AckTuple.Builder</a> newTuple, |
| long tupleSizeInBytes)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addDataTuple(java.lang.String,org.apache.heron.proto.system.HeronTuples.HeronDataTuple.Builder,long)">addDataTuple</a></span>​(java.lang.String streamId, |
| <a href="../proto/system/HeronTuples.HeronDataTuple.Builder.html" title="class in org.apache.heron.proto.system">HeronTuples.HeronDataTuple.Builder</a> newTuple, |
| long tupleSizeInBytes)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFailTuple(org.apache.heron.proto.system.HeronTuples.AckTuple.Builder,long)">addFailTuple</a></span>​(<a href="../proto/system/HeronTuples.AckTuple.Builder.html" title="class in org.apache.heron.proto.system">HeronTuples.AckTuple.Builder</a> newTuple, |
| long tupleSizeInBytes)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTotalDataEmittedInBytes()">getTotalDataEmittedInBytes</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOutQueuesAvailable()">isOutQueuesAvailable</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendOutState(org.apache.heron.api.state.State,java.lang.String,boolean,java.lang.String)">sendOutState</a></span>​(<a href="../api/state/State.html" title="interface in org.apache.heron.api.state">State</a><java.io.Serializable,​java.io.Serializable> state, |
| java.lang.String checkpointId, |
| boolean spillState, |
| java.lang.String location)</code></th> |
| <td class="colLast"> |
| <div class="block">Send out the instance's state with corresponding checkpointId.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendOutTuples()">sendOutTuples</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updatePhysicalPlanHelper(org.apache.heron.common.utils.misc.PhysicalPlanHelper)">updatePhysicalPlanHelper</a></span>​(<a href="../common/utils/misc/PhysicalPlanHelper.html" title="class in org.apache.heron.common.utils.misc">PhysicalPlanHelper</a> physicalPlanHelper)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="helper"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>helper</h4> |
| <pre>protected <a href="../common/utils/misc/PhysicalPlanHelper.html" title="class in org.apache.heron.common.utils.misc">PhysicalPlanHelper</a> helper</pre> |
| </li> |
| </ul> |
| <a id="metrics"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>metrics</h4> |
| <pre>protected final <a href="../common/utils/metrics/ComponentMetrics.html" title="interface in org.apache.heron.common.utils.metrics">ComponentMetrics</a> metrics</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.heron.common.utils.misc.PhysicalPlanHelper,org.apache.heron.common.basics.Communicator,java.util.concurrent.locks.ReentrantLock,org.apache.heron.common.utils.metrics.ComponentMetrics)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>OutgoingTupleCollection</h4> |
| <pre>public OutgoingTupleCollection​(<a href="../common/utils/misc/PhysicalPlanHelper.html" title="class in org.apache.heron.common.utils.misc">PhysicalPlanHelper</a> helper, |
| <a href="../common/basics/Communicator.html" title="class in org.apache.heron.common.basics">Communicator</a><com.google.protobuf.Message> outQueue, |
| java.util.concurrent.locks.ReentrantLock lock, |
| <a href="../common/utils/metrics/ComponentMetrics.html" title="interface in org.apache.heron.common.utils.metrics">ComponentMetrics</a> metrics)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="sendOutTuples()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendOutTuples</h4> |
| <pre class="methodSignature">public void sendOutTuples()</pre> |
| </li> |
| </ul> |
| <a id="sendOutState(org.apache.heron.api.state.State,java.lang.String,boolean,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendOutState</h4> |
| <pre class="methodSignature">public void sendOutState​(<a href="../api/state/State.html" title="interface in org.apache.heron.api.state">State</a><java.io.Serializable,​java.io.Serializable> state, |
| java.lang.String checkpointId, |
| boolean spillState, |
| java.lang.String location)</pre> |
| <div class="block">Send out the instance's state with corresponding checkpointId. If spillState is True, |
| the actual state is spill to disk and only the state location is sent out.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>state</code> - instance's state</dd> |
| <dd><code>checkpointId</code> - the checkpointId</dd> |
| <dd><code>spillState</code> - spill the state to local disk if true</dd> |
| <dd><code>location</code> - the location where state is spilled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addDataTuple(java.lang.String,org.apache.heron.proto.system.HeronTuples.HeronDataTuple.Builder,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDataTuple</h4> |
| <pre class="methodSignature">public void addDataTuple​(java.lang.String streamId, |
| <a href="../proto/system/HeronTuples.HeronDataTuple.Builder.html" title="class in org.apache.heron.proto.system">HeronTuples.HeronDataTuple.Builder</a> newTuple, |
| long tupleSizeInBytes)</pre> |
| </li> |
| </ul> |
| <a id="addAckTuple(org.apache.heron.proto.system.HeronTuples.AckTuple.Builder,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAckTuple</h4> |
| <pre class="methodSignature">public void addAckTuple​(<a href="../proto/system/HeronTuples.AckTuple.Builder.html" title="class in org.apache.heron.proto.system">HeronTuples.AckTuple.Builder</a> newTuple, |
| long tupleSizeInBytes)</pre> |
| </li> |
| </ul> |
| <a id="addFailTuple(org.apache.heron.proto.system.HeronTuples.AckTuple.Builder,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFailTuple</h4> |
| <pre class="methodSignature">public void addFailTuple​(<a href="../proto/system/HeronTuples.AckTuple.Builder.html" title="class in org.apache.heron.proto.system">HeronTuples.AckTuple.Builder</a> newTuple, |
| long tupleSizeInBytes)</pre> |
| </li> |
| </ul> |
| <a id="isOutQueuesAvailable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOutQueuesAvailable</h4> |
| <pre class="methodSignature">public boolean isOutQueuesAvailable()</pre> |
| </li> |
| </ul> |
| <a id="getTotalDataEmittedInBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalDataEmittedInBytes</h4> |
| <pre class="methodSignature">public long getTotalDataEmittedInBytes()</pre> |
| </li> |
| </ul> |
| <a id="clear()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre class="methodSignature">public void clear()</pre> |
| </li> |
| </ul> |
| <a id="updatePhysicalPlanHelper(org.apache.heron.common.utils.misc.PhysicalPlanHelper)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>updatePhysicalPlanHelper</h4> |
| <pre class="methodSignature">public void updatePhysicalPlanHelper​(<a href="../common/utils/misc/PhysicalPlanHelper.html" title="class in org.apache.heron.common.utils.misc">PhysicalPlanHelper</a> physicalPlanHelper)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All 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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
