org.apache.paimon.service.network

类 AbstractServerHandler<REQ extends MessageBody,RESP extends MessageBody>

java.lang.Object

org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandlerAdapter

org.apache.paimon.shade.netty4.io.netty.channel.ChannelInboundHandlerAdapter

org.apache.paimon.service.network.AbstractServerHandler<REQ,RESP>

类型参数:

REQ - the type of request the server expects to receive.

RESP - the type of response the server will send.

所有已实现的接口:

org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandler, org.apache.paimon.shade.netty4.io.netty.channel.ChannelInboundHandler

@ChannelHandler.Sharable
public abstract class AbstractServerHandler<REQ extends MessageBody,RESP extends MessageBody>
extends org.apache.paimon.shade.netty4.io.netty.channel.ChannelInboundHandlerAdapter

The base class of every handler used by an NetworkServer.

嵌套类概要

从接口继承的嵌套类/接口 org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandler

org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandler.Sharable

字段概要

字段

限定符和类型	字段和说明
protected ExecutorService	queryExecutor Thread pool for query execution.

构造器概要

构造器

构造器和说明
AbstractServerHandler(NetworkServer<REQ,RESP> server, MessageSerializer<REQ,RESP> serializer, ServiceRequestStats stats) Create the handler.

方法概要

限定符和类型	方法和说明
void	channelActive(org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandlerContext ctx)
void	channelInactive(org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandlerContext ctx)
void	channelRead(org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandlerContext ctx, Object msg)
void	exceptionCaught(org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
protected String	getServerName()
abstract CompletableFuture<RESP>	handleRequest(long requestId, REQ request) Handles an incoming request and returns a CompletableFuture containing the corresponding response.
abstract CompletableFuture<Void>	shutdown() Shuts down any handler-specific resources, e.g. thread pools etc and returns a CompletableFuture.

从类继承的方法 org.apache.paimon.shade.netty4.io.netty.channel.ChannelInboundHandlerAdapter

channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

从类继承的方法 org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

字段详细资料

queryExecutor

protected final ExecutorService queryExecutor

Thread pool for query execution.

构造器详细资料

AbstractServerHandler

public AbstractServerHandler(NetworkServer<REQ,RESP> server,
                             MessageSerializer<REQ,RESP> serializer,
                             ServiceRequestStats stats)

Create the handler.

参数:

serializer - the serializer used to (de-)serialize messages

stats - statistics collector

方法详细资料

getServerName

protected String getServerName()

channelActive

public void channelActive(org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandlerContext ctx)

指定者:

channelActive 在接口中 org.apache.paimon.shade.netty4.io.netty.channel.ChannelInboundHandler

覆盖:

channelActive 在类中 org.apache.paimon.shade.netty4.io.netty.channel.ChannelInboundHandlerAdapter

channelInactive

public void channelInactive(org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandlerContext ctx)

指定者:

channelInactive 在接口中 org.apache.paimon.shade.netty4.io.netty.channel.ChannelInboundHandler

覆盖:

channelInactive 在类中 org.apache.paimon.shade.netty4.io.netty.channel.ChannelInboundHandlerAdapter

channelRead

public void channelRead(org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandlerContext ctx,
                        Object msg)
                 throws Exception

指定者:

channelRead 在接口中 org.apache.paimon.shade.netty4.io.netty.channel.ChannelInboundHandler

覆盖:

channelRead 在类中 org.apache.paimon.shade.netty4.io.netty.channel.ChannelInboundHandlerAdapter

抛出:

Exception

exceptionCaught

public void exceptionCaught(org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandlerContext ctx,
                            Throwable cause)
                     throws Exception

指定者:

exceptionCaught 在接口中 org.apache.paimon.shade.netty4.io.netty.channel.ChannelHandler

指定者:

exceptionCaught 在接口中 org.apache.paimon.shade.netty4.io.netty.channel.ChannelInboundHandler

覆盖:

exceptionCaught 在类中 org.apache.paimon.shade.netty4.io.netty.channel.ChannelInboundHandlerAdapter

抛出:

Exception

handleRequest

public abstract CompletableFuture<RESP> handleRequest(long requestId,
                                                      REQ request)

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

NOTE: This method is called by multiple threads.

参数:

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

request - the request to be handled.

返回:

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

shutdown

public abstract CompletableFuture<Void> shutdown()

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.

返回:

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