| <!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_181-google-v7) on Mon Jan 27 16:42:31 PST 2020 --> |
| <title>BeamFnDataSizeBasedBufferingOutboundObserver (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-01-27"> |
| <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="BeamFnDataSizeBasedBufferingOutboundObserver (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":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="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/beam/sdk/fn/data/BeamFnDataInboundObserver.html" title="class in org.apache.beam.sdk.fn.data"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataTimeBasedBufferingOutboundObserver.html" title="class in org.apache.beam.sdk.fn.data"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/fn/data/BeamFnDataSizeBasedBufferingOutboundObserver.html" target="_top">Frames</a></li> |
| <li><a href="BeamFnDataSizeBasedBufferingOutboundObserver.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">org.apache.beam.sdk.fn.data</div> |
| <h2 title="Class BeamFnDataSizeBasedBufferingOutboundObserver" class="title">Class BeamFnDataSizeBasedBufferingOutboundObserver<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.fn.data.BeamFnDataSizeBasedBufferingOutboundObserver<T></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.lang.AutoCloseable, <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataBufferingOutboundObserver.html" title="interface in org.apache.beam.sdk.fn.data">BeamFnDataBufferingOutboundObserver</a><T>, <a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">CloseableFnDataReceiver</a><T>, <a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">FnDataReceiver</a><T></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataTimeBasedBufferingOutboundObserver.html" title="class in org.apache.beam.sdk.fn.data">BeamFnDataTimeBasedBufferingOutboundObserver</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">BeamFnDataSizeBasedBufferingOutboundObserver<T></span> |
| extends java.lang.Object |
| implements <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataBufferingOutboundObserver.html" title="interface in org.apache.beam.sdk.fn.data">BeamFnDataBufferingOutboundObserver</a><T></pre> |
| <div class="block">A size-based buffering outbound <a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data"><code>FnDataReceiver</code></a> for the Beam Fn Data API. |
| |
| <p>TODO: Handle outputting large elements (> 2GiBs). Note that this also applies to the input |
| side as well. |
| |
| <p>TODO: Handle outputting elements that are zero bytes by outputting a single byte as a marker, |
| detect on the input side that no bytes were read and force reading a single byte.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.fn.data.BeamFnDataBufferingOutboundObserver"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.beam.sdk.fn.data.<a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataBufferingOutboundObserver.html" title="interface in org.apache.beam.sdk.fn.data">BeamFnDataBufferingOutboundObserver</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataBufferingOutboundObserver.html#BEAM_FN_API_DATA_BUFFER_LIMIT">BEAM_FN_API_DATA_BUFFER_LIMIT</a>, <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataBufferingOutboundObserver.html#BEAM_FN_API_DATA_BUFFER_SIZE_LIMIT">BEAM_FN_API_DATA_BUFFER_SIZE_LIMIT</a>, <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataBufferingOutboundObserver.html#BEAM_FN_API_DATA_BUFFER_TIME_LIMIT">BEAM_FN_API_DATA_BUFFER_TIME_LIMIT</a>, <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataBufferingOutboundObserver.html#DATA_BUFFER_SIZE_LIMIT">DATA_BUFFER_SIZE_LIMIT</a>, <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataBufferingOutboundObserver.html#DATA_BUFFER_TIME_LIMIT_MS">DATA_BUFFER_TIME_LIMIT_MS</a>, <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataBufferingOutboundObserver.html#DEFAULT_BUFFER_LIMIT_BYTES">DEFAULT_BUFFER_LIMIT_BYTES</a>, <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataBufferingOutboundObserver.html#DEFAULT_BUFFER_LIMIT_TIME_MS">DEFAULT_BUFFER_LIMIT_TIME_MS</a></code></li> |
| </ul> |
| </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"> </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="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataSizeBasedBufferingOutboundObserver.html#accept-T-">accept</a></span>(<a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataSizeBasedBufferingOutboundObserver.html" title="type parameter in BeamFnDataSizeBasedBufferingOutboundObserver">T</a> t)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataSizeBasedBufferingOutboundObserver.html#close--">close</a></span>()</code> |
| <div class="block">.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataSizeBasedBufferingOutboundObserver.html#flush--">flush</a></span>()</code> |
| <div class="block">Eagerly flushes any data that is buffered in this channel.</div> |
| </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.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.fn.data.BeamFnDataBufferingOutboundObserver"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.beam.sdk.fn.data.<a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataBufferingOutboundObserver.html" title="interface in org.apache.beam.sdk.fn.data">BeamFnDataBufferingOutboundObserver</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataBufferingOutboundObserver.html#forLocation-org.apache.beam.sdk.options.PipelineOptions-org.apache.beam.sdk.fn.data.LogicalEndpoint-org.apache.beam.sdk.coders.Coder-org.apache.beam.vendor.grpc.v1p26p0.io.grpc.stub.StreamObserver-">forLocation</a>, <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataBufferingOutboundObserver.html#getSizeLimit-org.apache.beam.sdk.options.PipelineOptions-">getSizeLimit</a>, <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataBufferingOutboundObserver.html#getTimeLimit-org.apache.beam.sdk.options.PipelineOptions-">getTimeLimit</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="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close() |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html#close--">CloseableFnDataReceiver</a></code></span></div> |
| <div class="block">. |
| |
| <p>Does nothing if this <a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data"><code>CloseableFnDataReceiver</code></a> is already closed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html#close--">close</a></code> in interface <code><a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">CloseableFnDataReceiver</a><<a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataSizeBasedBufferingOutboundObserver.html" title="type parameter in BeamFnDataSizeBasedBufferingOutboundObserver">T</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="flush--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flush</h4> |
| <pre>public void flush() |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html#flush--">CloseableFnDataReceiver</a></code></span></div> |
| <div class="block">Eagerly flushes any data that is buffered in this channel.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html#flush--">flush</a></code> in interface <code><a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">CloseableFnDataReceiver</a><<a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataSizeBasedBufferingOutboundObserver.html" title="type parameter in BeamFnDataSizeBasedBufferingOutboundObserver">T</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="accept-java.lang.Object-"> |
| <!-- --> |
| </a><a name="accept-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>accept</h4> |
| <pre>public void accept(<a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataSizeBasedBufferingOutboundObserver.html" title="type parameter in BeamFnDataSizeBasedBufferingOutboundObserver">T</a> t) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html#accept-T-">accept</a></code> in interface <code><a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">FnDataReceiver</a><<a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataSizeBasedBufferingOutboundObserver.html" title="type parameter in BeamFnDataSizeBasedBufferingOutboundObserver">T</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></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="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/beam/sdk/fn/data/BeamFnDataInboundObserver.html" title="class in org.apache.beam.sdk.fn.data"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataTimeBasedBufferingOutboundObserver.html" title="class in org.apache.beam.sdk.fn.data"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/fn/data/BeamFnDataSizeBasedBufferingOutboundObserver.html" target="_top">Frames</a></li> |
| <li><a href="BeamFnDataSizeBasedBufferingOutboundObserver.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 ======= --> |
| </body> |
| </html> |