org.apache.beam.runners.fnexecution.control

Class FnApiControlClientPoolService

java.lang.Object

org.apache.beam.model.fnexecution.v1.BeamFnControlGrpc.BeamFnControlImplBase

org.apache.beam.runners.fnexecution.control.FnApiControlClientPoolService

All Implemented Interfaces:

io.grpc.BindableService, java.lang.AutoCloseable, FnService

public class FnApiControlClientPoolService
extends org.apache.beam.model.fnexecution.v1.BeamFnControlGrpc.BeamFnControlImplBase
implements FnService

A Fn API control service which adds incoming SDK harness connections to a pool.

Method Summary

Modifier and Type	Method and Description
void	close() .
io.grpc.stub.StreamObserver<org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionResponse>	control(io.grpc.stub.StreamObserver<org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionRequest> requestObserver) Called by gRPC for each incoming connection from an SDK harness, and enqueue an available SDK harness client.
static FnApiControlClientPoolService	offeringClientsToPool(java.util.concurrent.BlockingQueue<FnApiControlClient> clientPool) Creates a new FnApiControlClientPoolService which will enqueue and vend new SDK harness connections.

Methods inherited from class org.apache.beam.model.fnexecution.v1.BeamFnControlGrpc.BeamFnControlImplBase

bindService

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.grpc.BindableService

bindService

Method Detail

offeringClientsToPool

public static FnApiControlClientPoolService offeringClientsToPool(java.util.concurrent.BlockingQueue<FnApiControlClient> clientPool)

Creates a new FnApiControlClientPoolService which will enqueue and vend new SDK harness connections.

Clients placed into the clientPool are owned by whichever consumer owns the pool. That consumer is responsible for closing the clients when they are no longer needed.

control

public io.grpc.stub.StreamObserver<org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionResponse> control(io.grpc.stub.StreamObserver<org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionRequest> requestObserver)

Called by gRPC for each incoming connection from an SDK harness, and enqueue an available SDK harness client.

Note: currently does not distinguish what sort of SDK it is, so a separate instance is required for each.

Overrides:

control in class org.apache.beam.model.fnexecution.v1.BeamFnControlGrpc.BeamFnControlImplBase

close

public void close()
           throws java.lang.Exception

Description copied from interface: FnService

.

There should be no more calls to any service method by the time a call to FnService.close() begins. Specifically, this means that a Server that this service is bound to should have completed a call to the Server.shutdown() method, and all future incoming calls will be rejected.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface FnService

Throws:

java.lang.Exception