blob: 68b9297f7e0f778ad90c88d20fdd95dba7b84d98 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>BaseTaskHook (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="BaseTaskHook (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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&nbsp;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:&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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.heron.api.hooks</a></div>
<h2 title="Class BaseTaskHook" class="title">Class BaseTaskHook</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.heron.api.hooks.BaseTaskHook</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="ITaskHook.html" title="interface in org.apache.heron.api.hooks">ITaskHook</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">BaseTaskHook</span>
extends java.lang.Object
implements <a href="ITaskHook.html" title="interface in org.apache.heron.api.hooks">ITaskHook</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">&nbsp;</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()">BaseTaskHook</a></span>()</code></th>
<td class="colLast">&nbsp;</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">&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="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="#boltAck(org.apache.heron.api.hooks.info.BoltAckInfo)">boltAck</a></span>&#8203;(<a href="info/BoltAckInfo.html" title="class in org.apache.heron.api.hooks.info">BoltAckInfo</a>&nbsp;info)</code></th>
<td class="colLast">
<div class="block">Called in bolt everytime a tuple gets acked</div>
</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="#boltExecute(org.apache.heron.api.hooks.info.BoltExecuteInfo)">boltExecute</a></span>&#8203;(<a href="info/BoltExecuteInfo.html" title="class in org.apache.heron.api.hooks.info">BoltExecuteInfo</a>&nbsp;info)</code></th>
<td class="colLast">
<div class="block">Called in bolt everytime a tuple gets executed</div>
</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="#boltFail(org.apache.heron.api.hooks.info.BoltFailInfo)">boltFail</a></span>&#8203;(<a href="info/BoltFailInfo.html" title="class in org.apache.heron.api.hooks.info">BoltFailInfo</a>&nbsp;info)</code></th>
<td class="colLast">
<div class="block">Called in bolt everytime a tuple gets failed</div>
</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="#cleanup()">cleanup</a></span>()</code></th>
<td class="colLast">
<div class="block">Called just before the spout/bolt's cleanup method is called.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#emit(org.apache.heron.api.hooks.info.EmitInfo)">emit</a></span>&#8203;(<a href="info/EmitInfo.html" title="class in org.apache.heron.api.hooks.info">EmitInfo</a>&nbsp;info)</code></th>
<td class="colLast">
<div class="block">Called everytime a tuple is emitted in spout/bolt</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext)">prepare</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;conf,
<a href="../topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Called after the spout/bolt's open/prepare method is called
conf is the Config thats passed to the topology</div>
</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="#spoutAck(org.apache.heron.api.hooks.info.SpoutAckInfo)">spoutAck</a></span>&#8203;(<a href="info/SpoutAckInfo.html" title="class in org.apache.heron.api.hooks.info">SpoutAckInfo</a>&nbsp;info)</code></th>
<td class="colLast">
<div class="block">Called in spout everytime a tuple gets acked</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="#spoutFail(org.apache.heron.api.hooks.info.SpoutFailInfo)">spoutFail</a></span>&#8203;(<a href="info/SpoutFailInfo.html" title="class in org.apache.heron.api.hooks.info">SpoutFailInfo</a>&nbsp;info)</code></th>
<td class="colLast">
<div class="block">Called in spout everytime a tuple gets failed</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="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>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BaseTaskHook</h4>
<pre>public&nbsp;BaseTaskHook()</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="prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;prepare&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;conf,
<a href="../topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="ITaskHook.html#prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext)">ITaskHook</a></code></span></div>
<div class="block">Called after the spout/bolt's open/prepare method is called
conf is the Config thats passed to the topology</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ITaskHook.html#prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext)">prepare</a></code>&nbsp;in interface&nbsp;<code><a href="ITaskHook.html" title="interface in org.apache.heron.api.hooks">ITaskHook</a></code></dd>
</dl>
</li>
</ul>
<a id="cleanup()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleanup</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;cleanup()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="ITaskHook.html#cleanup()">ITaskHook</a></code></span></div>
<div class="block">Called just before the spout/bolt's cleanup method is called.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ITaskHook.html#cleanup()">cleanup</a></code>&nbsp;in interface&nbsp;<code><a href="ITaskHook.html" title="interface in org.apache.heron.api.hooks">ITaskHook</a></code></dd>
</dl>
</li>
</ul>
<a id="emit(org.apache.heron.api.hooks.info.EmitInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emit</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;emit&#8203;(<a href="info/EmitInfo.html" title="class in org.apache.heron.api.hooks.info">EmitInfo</a>&nbsp;info)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="ITaskHook.html#emit(org.apache.heron.api.hooks.info.EmitInfo)">ITaskHook</a></code></span></div>
<div class="block">Called everytime a tuple is emitted in spout/bolt</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ITaskHook.html#emit(org.apache.heron.api.hooks.info.EmitInfo)">emit</a></code>&nbsp;in interface&nbsp;<code><a href="ITaskHook.html" title="interface in org.apache.heron.api.hooks">ITaskHook</a></code></dd>
</dl>
</li>
</ul>
<a id="spoutAck(org.apache.heron.api.hooks.info.SpoutAckInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>spoutAck</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;spoutAck&#8203;(<a href="info/SpoutAckInfo.html" title="class in org.apache.heron.api.hooks.info">SpoutAckInfo</a>&nbsp;info)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="ITaskHook.html#spoutAck(org.apache.heron.api.hooks.info.SpoutAckInfo)">ITaskHook</a></code></span></div>
<div class="block">Called in spout everytime a tuple gets acked</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ITaskHook.html#spoutAck(org.apache.heron.api.hooks.info.SpoutAckInfo)">spoutAck</a></code>&nbsp;in interface&nbsp;<code><a href="ITaskHook.html" title="interface in org.apache.heron.api.hooks">ITaskHook</a></code></dd>
</dl>
</li>
</ul>
<a id="spoutFail(org.apache.heron.api.hooks.info.SpoutFailInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>spoutFail</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;spoutFail&#8203;(<a href="info/SpoutFailInfo.html" title="class in org.apache.heron.api.hooks.info">SpoutFailInfo</a>&nbsp;info)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="ITaskHook.html#spoutFail(org.apache.heron.api.hooks.info.SpoutFailInfo)">ITaskHook</a></code></span></div>
<div class="block">Called in spout everytime a tuple gets failed</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ITaskHook.html#spoutFail(org.apache.heron.api.hooks.info.SpoutFailInfo)">spoutFail</a></code>&nbsp;in interface&nbsp;<code><a href="ITaskHook.html" title="interface in org.apache.heron.api.hooks">ITaskHook</a></code></dd>
</dl>
</li>
</ul>
<a id="boltAck(org.apache.heron.api.hooks.info.BoltAckInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>boltAck</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;boltAck&#8203;(<a href="info/BoltAckInfo.html" title="class in org.apache.heron.api.hooks.info">BoltAckInfo</a>&nbsp;info)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="ITaskHook.html#boltAck(org.apache.heron.api.hooks.info.BoltAckInfo)">ITaskHook</a></code></span></div>
<div class="block">Called in bolt everytime a tuple gets acked</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ITaskHook.html#boltAck(org.apache.heron.api.hooks.info.BoltAckInfo)">boltAck</a></code>&nbsp;in interface&nbsp;<code><a href="ITaskHook.html" title="interface in org.apache.heron.api.hooks">ITaskHook</a></code></dd>
</dl>
</li>
</ul>
<a id="boltFail(org.apache.heron.api.hooks.info.BoltFailInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>boltFail</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;boltFail&#8203;(<a href="info/BoltFailInfo.html" title="class in org.apache.heron.api.hooks.info">BoltFailInfo</a>&nbsp;info)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="ITaskHook.html#boltFail(org.apache.heron.api.hooks.info.BoltFailInfo)">ITaskHook</a></code></span></div>
<div class="block">Called in bolt everytime a tuple gets failed</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ITaskHook.html#boltFail(org.apache.heron.api.hooks.info.BoltFailInfo)">boltFail</a></code>&nbsp;in interface&nbsp;<code><a href="ITaskHook.html" title="interface in org.apache.heron.api.hooks">ITaskHook</a></code></dd>
</dl>
</li>
</ul>
<a id="boltExecute(org.apache.heron.api.hooks.info.BoltExecuteInfo)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>boltExecute</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;boltExecute&#8203;(<a href="info/BoltExecuteInfo.html" title="class in org.apache.heron.api.hooks.info">BoltExecuteInfo</a>&nbsp;info)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="ITaskHook.html#boltExecute(org.apache.heron.api.hooks.info.BoltExecuteInfo)">ITaskHook</a></code></span></div>
<div class="block">Called in bolt everytime a tuple gets executed</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ITaskHook.html#boltExecute(org.apache.heron.api.hooks.info.BoltExecuteInfo)">boltExecute</a></code>&nbsp;in interface&nbsp;<code><a href="ITaskHook.html" title="interface in org.apache.heron.api.hooks">ITaskHook</a></code></dd>
</dl>
</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&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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>