org.apache.beam.sdk.fn.stream

Class OutboundObserverFactory

java.lang.Object

org.apache.beam.sdk.fn.stream.OutboundObserverFactory

public abstract class OutboundObserverFactory
extends java.lang.Object

Creates factories which determine an underlying StreamObserver implementation to use in to interact with fn execution APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OutboundObserverFactory.BasicFactory<ReqT,RespT> Creates an outbound observer for the given inbound observer.

Constructor Summary

Constructors

Constructor and Description
OutboundObserverFactory()

Method Summary

Modifier and Type	Method and Description
static OutboundObserverFactory	clientBuffered(java.util.concurrent.ExecutorService executorService) Create a buffering OutboundObserverFactory for client-side RPCs with the specified ExecutorService and the default buffer size.
static OutboundObserverFactory	clientBuffered(java.util.concurrent.ExecutorService executorService, int bufferSize) Create a buffering OutboundObserverFactory for client-side RPCs with the specified ExecutorService and buffer size.
static OutboundObserverFactory	clientDirect() Create the default OutboundObserverFactory for client-side RPCs, which uses basic unbuffered flow control and adds synchronization to provide thread safety of access to the returned observer.
abstract <ReqT,RespT> org.apache.beam.vendor.grpc.v1.io.grpc.stub.StreamObserver<RespT>	outboundObserverFor(OutboundObserverFactory.BasicFactory<ReqT,RespT> baseOutboundObserverFactory, org.apache.beam.vendor.grpc.v1.io.grpc.stub.StreamObserver<ReqT> inboundObserver) Creates an outbound observer for the given inbound observer by potentially inserting hooks into the inbound and outbound observers.
static OutboundObserverFactory	serverDirect() Like clientDirect() but for server-side RPCs.
static OutboundObserverFactory	trivial() Creates an OutboundObserverFactory that simply delegates to the base factory, with no flow control or synchronization.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutboundObserverFactory

public OutboundObserverFactory()

Method Detail

clientBuffered

public static OutboundObserverFactory clientBuffered(java.util.concurrent.ExecutorService executorService)

Create a buffering OutboundObserverFactory for client-side RPCs with the specified ExecutorService and the default buffer size.

clientBuffered

public static OutboundObserverFactory clientBuffered(java.util.concurrent.ExecutorService executorService,
                                                     int bufferSize)

Create a buffering OutboundObserverFactory for client-side RPCs with the specified ExecutorService and buffer size.

clientDirect

public static OutboundObserverFactory clientDirect()

Create the default OutboundObserverFactory for client-side RPCs, which uses basic unbuffered flow control and adds synchronization to provide thread safety of access to the returned observer.

serverDirect

public static OutboundObserverFactory serverDirect()

Like clientDirect() but for server-side RPCs.

trivial

public static OutboundObserverFactory trivial()

Creates an OutboundObserverFactory that simply delegates to the base factory, with no flow control or synchronization. Not recommended for use except in tests.

outboundObserverFor

public abstract <ReqT,RespT> org.apache.beam.vendor.grpc.v1.io.grpc.stub.StreamObserver<RespT> outboundObserverFor(OutboundObserverFactory.BasicFactory<ReqT,RespT> baseOutboundObserverFactory,
                                                                                                                   org.apache.beam.vendor.grpc.v1.io.grpc.stub.StreamObserver<ReqT> inboundObserver)

Creates an outbound observer for the given inbound observer by potentially inserting hooks into the inbound and outbound observers.

Parameters:

baseOutboundObserverFactory - A base function to create an outbound observer from an inbound observer.

inboundObserver - The inbound observer.