| <!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>BeamFnDataGrpcMultiplexer2 (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="BeamFnDataGrpcMultiplexer2 (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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/BeamFnDataGrpcMultiplexer.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/BeamFnDataInboundObserver.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/BeamFnDataGrpcMultiplexer2.html" target="_top">Frames</a></li> |
| <li><a href="BeamFnDataGrpcMultiplexer2.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 BeamFnDataGrpcMultiplexer2" class="title">Class BeamFnDataGrpcMultiplexer2</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.fn.data.BeamFnDataGrpcMultiplexer2</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.lang.AutoCloseable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">BeamFnDataGrpcMultiplexer2</span> |
| extends java.lang.Object |
| implements java.lang.AutoCloseable</pre> |
| <div class="block">A gRPC multiplexer for a specific <code>Endpoints.ApiServiceDescriptor</code>. |
| |
| <p>Multiplexes data for inbound consumers based upon their <code>instructionId</code>. |
| |
| <p>Multiplexing inbound and outbound streams is as thread safe as the consumers of those streams. |
| For inbound streams, this is as thread safe as the inbound observers. For outbound streams, this |
| is as thread safe as the underlying stream observer. |
| |
| <p>TODO: Add support for multiplexing over multiple outbound observers by stickying the output |
| location with a specific outbound observer.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataGrpcMultiplexer2.html#BeamFnDataGrpcMultiplexer2-org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor-org.apache.beam.sdk.fn.stream.OutboundObserverFactory-org.apache.beam.sdk.fn.stream.OutboundObserverFactory.BasicFactory-">BeamFnDataGrpcMultiplexer2</a></span>(org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor apiServiceDescriptor, |
| <a href="../../../../../../org/apache/beam/sdk/fn/stream/OutboundObserverFactory.html" title="class in org.apache.beam.sdk.fn.stream">OutboundObserverFactory</a> outboundObserverFactory, |
| <a href="../../../../../../org/apache/beam/sdk/fn/stream/OutboundObserverFactory.BasicFactory.html" title="interface in org.apache.beam.sdk.fn.stream">OutboundObserverFactory.BasicFactory</a><org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements,org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements> baseOutboundObserverFactory)</code> </td> |
| </tr> |
| </table> |
| </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/BeamFnDataGrpcMultiplexer2.html#close--">close</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>org.apache.beam.vendor.grpc.v1p43p2.io.grpc.stub.StreamObserver<org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataGrpcMultiplexer2.html#getInboundObserver--">getInboundObserver</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>org.apache.beam.vendor.grpc.v1p43p2.io.grpc.stub.StreamObserver<org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataGrpcMultiplexer2.html#getOutboundObserver--">getOutboundObserver</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataGrpcMultiplexer2.html#registerConsumer-java.lang.String-org.apache.beam.sdk.fn.data.CloseableFnDataReceiver-">registerConsumer</a></span>(java.lang.String instructionId, |
| <a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">CloseableFnDataReceiver</a><org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements> receiver)</code> |
| <div class="block">Registers a consumer for the specified intruction id.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataGrpcMultiplexer2.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataGrpcMultiplexer2.html#unregisterConsumer-java.lang.String-">unregisterConsumer</a></span>(java.lang.String instructionId)</code> |
| <div class="block">Unregisters a consumer.</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, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="BeamFnDataGrpcMultiplexer2-org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor-org.apache.beam.sdk.fn.stream.OutboundObserverFactory-org.apache.beam.sdk.fn.stream.OutboundObserverFactory.BasicFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BeamFnDataGrpcMultiplexer2</h4> |
| <pre>public BeamFnDataGrpcMultiplexer2(org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor apiServiceDescriptor, |
| <a href="../../../../../../org/apache/beam/sdk/fn/stream/OutboundObserverFactory.html" title="class in org.apache.beam.sdk.fn.stream">OutboundObserverFactory</a> outboundObserverFactory, |
| <a href="../../../../../../org/apache/beam/sdk/fn/stream/OutboundObserverFactory.BasicFactory.html" title="interface in org.apache.beam.sdk.fn.stream">OutboundObserverFactory.BasicFactory</a><org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements,org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements> baseOutboundObserverFactory)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ 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 java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInboundObserver--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInboundObserver</h4> |
| <pre>public org.apache.beam.vendor.grpc.v1p43p2.io.grpc.stub.StreamObserver<org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements> getInboundObserver()</pre> |
| </li> |
| </ul> |
| <a name="getOutboundObserver--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutboundObserver</h4> |
| <pre>public org.apache.beam.vendor.grpc.v1p43p2.io.grpc.stub.StreamObserver<org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements> getOutboundObserver()</pre> |
| </li> |
| </ul> |
| <a name="registerConsumer-java.lang.String-org.apache.beam.sdk.fn.data.CloseableFnDataReceiver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerConsumer</h4> |
| <pre>public void registerConsumer(java.lang.String instructionId, |
| <a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">CloseableFnDataReceiver</a><org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements> receiver)</pre> |
| <div class="block">Registers a consumer for the specified intruction id. |
| |
| <p>The <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataGrpcMultiplexer2.html" title="class in org.apache.beam.sdk.fn.data"><code>BeamFnDataGrpcMultiplexer2</code></a> partitions <code>BeamFnApi.Elements</code> with multiple |
| instruction ids ensuring that the receiver will only see <code>BeamFnApi.Elements</code> with a |
| single instruction id. |
| |
| <p>The caller must <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataGrpcMultiplexer2.html#unregisterConsumer-java.lang.String-"><code>unregister the consumer</code></a> when they no longer wish |
| to receive messages.</div> |
| </li> |
| </ul> |
| <a name="unregisterConsumer-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unregisterConsumer</h4> |
| <pre>public void unregisterConsumer(java.lang.String instructionId)</pre> |
| <div class="block">Unregisters a consumer.</div> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close() |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</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/BeamFnDataGrpcMultiplexer.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/BeamFnDataInboundObserver.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/BeamFnDataGrpcMultiplexer2.html" target="_top">Frames</a></li> |
| <li><a href="BeamFnDataGrpcMultiplexer2.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
