blob: bd14041cc20e3d6d6e5bbf47c534ad4347f3414a [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.9.1) on Fri Sep 09 19:30:40 KST 2022 -->
<title>org.apache.nemo.runtime.executor.data (Nemo Project 0.4 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-09-09">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.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.5.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.nemo.runtime.executor.data (Nemo Project 0.4 API)";
}
}
catch(err) {
}
//-->
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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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" 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>
<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>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.nemo.runtime.executor.data</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DataUtil.IteratorWithNumBytes.html" title="interface in org.apache.nemo.runtime.executor.data">DataUtil.IteratorWithNumBytes</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block"><code>Iterator</code> with interface to access to the number of bytes.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BlockManagerWorker.html" title="class in org.apache.nemo.runtime.executor.data">BlockManagerWorker</a></th>
<td class="colLast">
<div class="block">Executor-side block manager.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BlockTransferThrottler.html" title="class in org.apache.nemo.runtime.executor.data">BlockTransferThrottler</a></th>
<td class="colLast">
<div class="block">A class to restrict parallel connection per runtime edge.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BroadcastManagerWorker.html" title="class in org.apache.nemo.runtime.executor.data">BroadcastManagerWorker</a></th>
<td class="colLast">
<div class="block">Used by tasks to get/fetch (probably remote) broadcast variables.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DataUtil.html" title="class in org.apache.nemo.runtime.executor.data">DataUtil</a></th>
<td class="colLast">
<div class="block">Utility methods for data handling (e.g., (de)serialization).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DataUtil.InputStreamIterator.html" title="class in org.apache.nemo.runtime.executor.data">DataUtil.InputStreamIterator</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">An iterator that emits objects from <code>InputStream</code> using the corresponding <a href="../../../common/coder/DecoderFactory.html" title="interface in org.apache.nemo.common.coder"><code>DecoderFactory</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DirectByteBufferOutputStream.html" title="class in org.apache.nemo.runtime.executor.data">DirectByteBufferOutputStream</a></th>
<td class="colLast">
<div class="block">This class is a customized output stream implementation backed by
<code>ByteBuffer</code>, which utilizes off heap memory when writing the data via MemoryPoolAssigner.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FileArea.html" title="class in org.apache.nemo.runtime.executor.data">FileArea</a></th>
<td class="colLast">
<div class="block">A file area descriptor.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LimitedInputStream.html" title="class in org.apache.nemo.runtime.executor.data">LimitedInputStream</a></th>
<td class="colLast">
<div class="block">This class provide functionality to limit bytes read from <code>InputStream</code>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MemoryChunk.html" title="class in org.apache.nemo.runtime.executor.data">MemoryChunk</a></th>
<td class="colLast">
<div class="block">This class represents chunk of memory residing in off-heap region
managed by <a href="MemoryPoolAssigner.html" title="class in org.apache.nemo.runtime.executor.data"><code>MemoryPoolAssigner</code></a>, which is backed by <code>ByteBuffer</code>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MemoryPoolAssigner.html" title="class in org.apache.nemo.runtime.executor.data">MemoryPoolAssigner</a></th>
<td class="colLast">
<div class="block">The MemoryPoolAssigner assigns the memory that Nemo uses for writing data blocks from the <code>MemoryPoolAssigner.MemoryPool</code>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PipeContainer.html" title="class in org.apache.nemo.runtime.executor.data">PipeContainer</a></th>
<td class="colLast">
<div class="block">Writes happen in a serialized manner with <a href="PipeContainer.html#putPipeListIfAbsent(org.apache.nemo.common.Pair,int)"><code>PipeContainer.putPipeListIfAbsent(Pair, int)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PipeManagerWorker.html" title="class in org.apache.nemo.runtime.executor.data">PipeManagerWorker</a></th>
<td class="colLast">
<div class="block">Two threads use this class
- Network thread: Saves pipe connections created from destination tasks.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SerializerManager.html" title="class in org.apache.nemo.runtime.executor.data">SerializerManager</a></th>
<td class="colLast">
<div class="block">Mapping from RuntimeEdgeId to <a href="streamchainer/Serializer.html" title="class in org.apache.nemo.runtime.executor.data.streamchainer"><code>Serializer</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DataUtil.IteratorWithNumBytes.NumBytesNotSupportedException.html" title="class in org.apache.nemo.runtime.executor.data">DataUtil.IteratorWithNumBytes.NumBytesNotSupportedException</a></th>
<td class="colLast">
<div class="block">Exception indicates <a href="DataUtil.IteratorWithNumBytes.html#getNumSerializedBytes()"><code>DataUtil.IteratorWithNumBytes.getNumSerializedBytes()</code></a> or <a href="DataUtil.IteratorWithNumBytes.html#getNumEncodedBytes()"><code>DataUtil.IteratorWithNumBytes.getNumEncodedBytes()</code></a> is not supported.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MemoryAllocationException.html" title="class in org.apache.nemo.runtime.executor.data">MemoryAllocationException</a></th>
<td class="colLast">
<div class="block">An exception to be thrown when a memory allocation operation is not successful.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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" 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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>