blob: 1638a0a371aa23be37253282679a2527f828f972 [file] [log] [blame]
<!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 -->
<title>org.apache.beam.sdk.fn.stream (Apache Beam 2.38.0-SNAPSHOT)</title>
<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="org.apache.beam.sdk.fn.stream (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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/splittabledofn/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/fn/test/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/fn/stream/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.sdk.fn.stream</h1>
<div class="docSummary">
<div class="block">gRPC stream management.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<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">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/DataStreams.OutputChunkConsumer.html" title="interface in org.apache.beam.sdk.fn.stream">DataStreams.OutputChunkConsumer</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A callback which is invoked whenever the <a href="../../../../../../org/apache/beam/sdk/fn/stream/DataStreams.html#outbound-org.apache.beam.sdk.fn.stream.DataStreams.OutputChunkConsumer-"><code>DataStreams.outbound(org.apache.beam.sdk.fn.stream.DataStreams.OutputChunkConsumer&lt;org.apache.beam.vendor.grpc.v1p43p2.com.google.protobuf.ByteString&gt;)</code></a> <code>OutputStream</code> becomes full.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/OutboundObserverFactory.BasicFactory.html" title="interface in org.apache.beam.sdk.fn.stream">OutboundObserverFactory.BasicFactory</a>&lt;ReqT,RespT&gt;</td>
<td class="colLast">
<div class="block">Creates an outbound observer for the given inbound observer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterable.html" title="interface in org.apache.beam.sdk.fn.stream">PrefetchableIterable</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">An <code>Iterable</code> that returns <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream"><code>PrefetchableIterator</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream">PrefetchableIterator</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block"><code>Iterator</code> that supports prefetching the next set of records.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<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">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/AdvancingPhaser.html" title="class in org.apache.beam.sdk.fn.stream">AdvancingPhaser</a></td>
<td class="colLast">
<div class="block">A <code>Phaser</code> which never terminates.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/BufferingStreamObserver.html" title="class in org.apache.beam.sdk.fn.stream">BufferingStreamObserver</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A thread safe <code>StreamObserver</code> which uses a bounded queue to pass elements to a processing
thread responsible for interacting with the underlying <code>CallStreamObserver</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/DataStreams.html" title="class in org.apache.beam.sdk.fn.stream">DataStreams</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../../org/apache/beam/sdk/fn/stream/DataStreams.DataStreamDecoder.html" title="class in org.apache.beam.sdk.fn.stream"><code>DataStreams.DataStreamDecoder</code></a> treats multiple <code>ByteString</code>s as a single input stream decoding
values with the supplied iterator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/DataStreams.DataStreamDecoder.html" title="class in org.apache.beam.sdk.fn.stream">DataStreams.DataStreamDecoder</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">An adapter which converts an <code>InputStream</code> to a <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream"><code>PrefetchableIterator</code></a> of <code>T</code>
values using the specified <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/DataStreams.ElementDelimitedOutputStream.html" title="class in org.apache.beam.sdk.fn.stream">DataStreams.ElementDelimitedOutputStream</a></td>
<td class="colLast">
<div class="block">An adapter which wraps an <a href="../../../../../../org/apache/beam/sdk/fn/stream/DataStreams.OutputChunkConsumer.html" title="interface in org.apache.beam.sdk.fn.stream"><code>DataStreams.OutputChunkConsumer</code></a> as an <code>OutputStream</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/DirectStreamObserver.html" title="class in org.apache.beam.sdk.fn.stream">DirectStreamObserver</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A <code>StreamObserver</code> which uses synchronization on the underlying <code>CallStreamObserver</code>
to provide thread safety.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/ForwardingClientResponseObserver.html" title="class in org.apache.beam.sdk.fn.stream">ForwardingClientResponseObserver</a>&lt;ReqT,RespT&gt;</td>
<td class="colLast">
<div class="block">A <code>ClientResponseObserver</code> which delegates all <code>StreamObserver</code> calls.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/OutboundObserverFactory.html" title="class in org.apache.beam.sdk.fn.stream">OutboundObserverFactory</a></td>
<td class="colLast">
<div class="block">Creates factories which determine an underlying <code>StreamObserver</code> implementation to use in
to interact with fn execution APIs.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterables.html" title="class in org.apache.beam.sdk.fn.stream">PrefetchableIterables</a></td>
<td class="colLast">
<div class="block">This class contains static utility functions that operate on or return objects of type <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterable.html" title="interface in org.apache.beam.sdk.fn.stream"><code>PrefetchableIterable</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterables.Default.html" title="class in org.apache.beam.sdk.fn.stream">PrefetchableIterables.Default</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A default implementation that caches an iterator to be returned when <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterables.Default.html#prefetch--"><code>PrefetchableIterables.Default.prefetch()</code></a> is
invoked.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterators.html" title="class in org.apache.beam.sdk.fn.stream">PrefetchableIterators</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/stream/SynchronizedStreamObserver.html" title="class in org.apache.beam.sdk.fn.stream">SynchronizedStreamObserver</a>&lt;V&gt;</td>
<td class="colLast">
<div class="block">A <code>StreamObserver</code> which provides synchronous access access to an underlying <code>StreamObserver</code>.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.fn.stream Description">Package org.apache.beam.sdk.fn.stream Description</h2>
<div class="block">gRPC stream management.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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/splittabledofn/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/fn/test/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/fn/stream/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.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>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>