| <!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_102) on Mon Dec 18 16:13:30 KST 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>BlockInputStream (Onyx Project 0.1-SNAPSHOT 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="BlockInputStream (Onyx Project 0.1-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":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/BlockInputStream.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 Class</li> |
| <li><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockOutputStream.html" title="class in edu.snu.onyx.runtime.executor.data.blocktransfer"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" target="_top">Frames</a></li> |
| <li><a href="BlockInputStream.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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">edu.snu.onyx.runtime.executor.data.blocktransfer</div> |
| <h2 title="Class BlockInputStream" class="title">Class BlockInputStream<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://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>edu.snu.onyx.runtime.executor.data.blocktransfer.BlockInputStream<T></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of element</dd> |
| </dl> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html" title="interface in edu.snu.onyx.runtime.executor.data.blocktransfer">BlockStream</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><T></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">BlockInputStream<T></span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><T>, <a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html" title="interface in edu.snu.onyx.runtime.executor.data.blocktransfer">BlockStream</a></pre> |
| <div class="block">Input stream for block transfer. |
| |
| Decodes and stores inbound data elements from other executors. Three threads are involved. |
| <ul> |
| <li>Netty <code>EventLoopGroup</code> receives data from other executors and adds them |
| by <a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html#append-io.netty.buffer.ByteBuf-"><code>append(ByteBuf)</code></a></li> |
| <li><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockTransfer.html#inboundExecutorService"><code>BlockTransfer.inboundExecutorService</code></a> decodes <code>ByteBuf</code>s into elements</li> |
| <li>User thread may use <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> to iterate over this object for their own work.</li> |
| </ul></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"> </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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html#forEach-java.util.function.Consumer-">forEach</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a><? super <a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" title="type parameter in BlockInputStream">T</a>> consumer)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://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="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html#getBlockId--">getBlockId</a></span>()</code> |
| <div class="block">Gets the block id.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="../../../../../../../edu/snu/onyx/common/ir/edge/executionproperty/DataStoreProperty.Value.html" title="enum in edu.snu.onyx.common.ir.edge.executionproperty">DataStoreProperty.Value</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html#getBlockStore--">getBlockStore</a></span>()</code> |
| <div class="block">Gets the block store type.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" title="class in edu.snu.onyx.runtime.executor.data.blocktransfer">BlockInputStream</a><<a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" title="type parameter in BlockInputStream">T</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html#getCompleteFuture--">getCompleteFuture</a></span>()</code> |
| <div class="block">Gets a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> that completes with the block transfer being done.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../edu/snu/onyx/runtime/common/data/KeyRange.html" title="interface in edu.snu.onyx.runtime.common.data">KeyRange</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html#getKeyRange--">getKeyRange</a></span>()</code> |
| <div class="block">Gets the key range.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://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="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html#getRemoteExecutorId--">getRemoteExecutorId</a></span>()</code> |
| <div class="block">Gets the id of the remote executor.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://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="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html#getRuntimeEdgeId--">getRuntimeEdgeId</a></span>()</code> |
| <div class="block">Gets the runtime edge id.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html#isEncodePartialBlockEnabled--">isEncodePartialBlockEnabled</a></span>()</code> |
| <div class="block">Gets whether the sender should start encoding even though the whole block has not been written yet.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" title="type parameter in BlockInputStream">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html#iterator--">iterator</a></span>()</code> |
| <div class="block">Returns an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> for this <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Spliterator.html?is-external=true" title="class or interface in java.util">Spliterator</a><<a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" title="type parameter in BlockInputStream">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html#spliterator--">spliterator</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://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="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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> |
| </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="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRemoteExecutorId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteExecutorId</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getRemoteExecutorId()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html#getRemoteExecutorId--">BlockStream</a></code></span></div> |
| <div class="block">Gets the id of the remote executor.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html#getRemoteExecutorId--">getRemoteExecutorId</a></code> in interface <code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html" title="interface in edu.snu.onyx.runtime.executor.data.blocktransfer">BlockStream</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the remote executor id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isEncodePartialBlockEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEncodePartialBlockEnabled</h4> |
| <pre>public boolean isEncodePartialBlockEnabled()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html#isEncodePartialBlockEnabled--">BlockStream</a></code></span></div> |
| <div class="block">Gets whether the sender should start encoding even though the whole block has not been written yet.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html#isEncodePartialBlockEnabled--">isEncodePartialBlockEnabled</a></code> in interface <code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html" title="interface in edu.snu.onyx.runtime.executor.data.blocktransfer">BlockStream</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the sender should start encoding even though the whole block has not been written yet</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBlockStore--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBlockStore</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="../../../../../../../edu/snu/onyx/common/ir/edge/executionproperty/DataStoreProperty.Value.html" title="enum in edu.snu.onyx.common.ir.edge.executionproperty">DataStoreProperty.Value</a>> getBlockStore()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html#getBlockStore--">BlockStream</a></code></span></div> |
| <div class="block">Gets the block store type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html#getBlockStore--">getBlockStore</a></code> in interface <code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html" title="interface in edu.snu.onyx.runtime.executor.data.blocktransfer">BlockStream</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util"><code>Optional</code></a> with block store type if this stream belongs to a pull-based transfer, |
| an empty <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util"><code>Optional</code></a> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBlockId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBlockId</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getBlockId()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html#getBlockId--">BlockStream</a></code></span></div> |
| <div class="block">Gets the block id.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html#getBlockId--">getBlockId</a></code> in interface <code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html" title="interface in edu.snu.onyx.runtime.executor.data.blocktransfer">BlockStream</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the block id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRuntimeEdgeId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRuntimeEdgeId</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getRuntimeEdgeId()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html#getRuntimeEdgeId--">BlockStream</a></code></span></div> |
| <div class="block">Gets the runtime edge id.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html#getRuntimeEdgeId--">getRuntimeEdgeId</a></code> in interface <code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html" title="interface in edu.snu.onyx.runtime.executor.data.blocktransfer">BlockStream</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the runtime edge id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getKeyRange--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyRange</h4> |
| <pre>public <a href="../../../../../../../edu/snu/onyx/runtime/common/data/KeyRange.html" title="interface in edu.snu.onyx.runtime.common.data">KeyRange</a> getKeyRange()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html#getKeyRange--">BlockStream</a></code></span></div> |
| <div class="block">Gets the key range.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html#getKeyRange--">getKeyRange</a></code> in interface <code><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockStream.html" title="interface in edu.snu.onyx.runtime.executor.data.blocktransfer">BlockStream</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../../../../edu/snu/onyx/runtime/common/data/KeyRange.html" title="interface in edu.snu.onyx.runtime.common.data"><code>KeyRange</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="iterator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" title="type parameter in BlockInputStream">T</a>> iterator()</pre> |
| <div class="block">Returns an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> for this <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a>. |
| The end of this <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> can possibly mean an error during the block transfer. |
| Consider using <a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html#completeFuture"><code>completeFuture</code></a> and <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true#isCompletedExceptionally--" title="class or interface in java.util.concurrent"><code>CompletableFuture.isCompletedExceptionally()</code></a> to check it.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator--" title="class or interface in java.lang">iterator</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" title="type parameter in BlockInputStream">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> for this <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="forEach-java.util.function.Consumer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forEach</h4> |
| <pre>public void forEach(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a><? super <a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" title="type parameter in BlockInputStream">T</a>> consumer)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" title="type parameter in BlockInputStream">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="spliterator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>spliterator</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Spliterator.html?is-external=true" title="class or interface in java.util">Spliterator</a><<a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" title="type parameter in BlockInputStream">T</a>> spliterator()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" title="type parameter in BlockInputStream">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCompleteFuture--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getCompleteFuture</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" title="class in edu.snu.onyx.runtime.executor.data.blocktransfer">BlockInputStream</a><<a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" title="type parameter in BlockInputStream">T</a>>> getCompleteFuture()</pre> |
| <div class="block">Gets a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> that completes with the block transfer being done. |
| This future is completed by one of the decoding thread. Consider using separate <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent"><code>ExecutorService</code></a> when |
| chaining a task to this future.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> that completes with the block transfer being done</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/BlockInputStream.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 Class</li> |
| <li><a href="../../../../../../../edu/snu/onyx/runtime/executor/data/blocktransfer/BlockOutputStream.html" title="class in edu.snu.onyx.runtime.executor.data.blocktransfer"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?edu/snu/onyx/runtime/executor/data/blocktransfer/BlockInputStream.html" target="_top">Frames</a></li> |
| <li><a href="BlockInputStream.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2017. All rights reserved.</small></p> |
| </body> |
| </html> |