org.apache.flink.queryablestate.client.proxy

Class KvStateClientProxyHandler

java.lang.Object

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

org.apache.flink.queryablestate.network.AbstractServerHandler<KvStateRequest,KvStateResponse>

org.apache.flink.queryablestate.client.proxy.KvStateClientProxyHandler

All Implemented Interfaces:

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler, org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler

@Internal
 @ChannelHandler.Sharable
public class KvStateClientProxyHandler
extends AbstractServerHandler<KvStateRequest,KvStateResponse>

This handler acts as an internal (to the Flink cluster) client that receives the requests from external clients, executes them by contacting the Job Manager (if necessary) and the Task Manager holding the requested state, and forwards the answer back to the client.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class org.apache.flink.queryablestate.network.AbstractServerHandler

queryExecutor

Constructor Summary

Constructors

Constructor and Description
KvStateClientProxyHandler(KvStateClientProxyImpl proxy, int queryExecutorThreads, MessageSerializer<KvStateRequest,KvStateResponse> serializer, KvStateRequestStats stats) Create the handler used by the KvStateClientProxyImpl.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<KvStateResponse>	handleRequest(long requestId, KvStateRequest request) Handles an incoming request and returns a CompletableFuture containing the corresponding response.
CompletableFuture<Void>	shutdown() Shuts down any handler-specific resources, e.g. thread pools etc and returns a CompletableFuture.

Methods inherited from class org.apache.flink.queryablestate.network.AbstractServerHandler

channelActive, channelInactive, channelRead, exceptionCaught, getServerName

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

KvStateClientProxyHandler

public KvStateClientProxyHandler(KvStateClientProxyImpl proxy,
                                 int queryExecutorThreads,
                                 MessageSerializer<KvStateRequest,KvStateResponse> serializer,
                                 KvStateRequestStats stats)

Create the handler used by the KvStateClientProxyImpl.

Parameters:

proxy - the proxy using the handler.

queryExecutorThreads - the number of threads used to process incoming requests.

serializer - the MessageSerializer used to (de-) serialize the different messages.

stats - server statistics collector.

Method Detail

handleRequest

public CompletableFuture<KvStateResponse> handleRequest(long requestId,
                                                        KvStateRequest request)

Description copied from class: AbstractServerHandler

Handles an incoming request and returns a CompletableFuture containing the corresponding response.

NOTE: This method is called by multiple threads.

Specified by:

handleRequest in class AbstractServerHandler<KvStateRequest,KvStateResponse>

Parameters:

requestId - the id of the received request to be handled.

request - the request to be handled.

Returns:

A future with the response to be forwarded to the client.

shutdown

public CompletableFuture<Void> shutdown()

Description copied from class: AbstractServerHandler

Shuts down any handler-specific resources, e.g. thread pools etc and returns a CompletableFuture.

If an exception is thrown during the shutdown process, then that exception will be included in the returned future.

Specified by:

shutdown in class AbstractServerHandler<KvStateRequest,KvStateResponse>

Returns:

A CompletableFuture that will be completed when the shutdown process actually finishes.