io.seata.core.rpc.netty

Class AbstractNettyRemotingClient

java.lang.Object

io.seata.core.rpc.netty.AbstractNettyRemoting

io.seata.core.rpc.netty.AbstractNettyRemotingClient

All Implemented Interfaces:

Disposable, RemotingClient

Direct Known Subclasses:

RmNettyRemotingClient, TmNettyRemotingClient

public abstract class AbstractNettyRemotingClient
extends AbstractNettyRemoting
implements RemotingClient

The netty remoting client.

Author:

slievrly, zhaojun, zhangchenghui.dev@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
protected ConcurrentHashMap<String,BlockingQueue<RpcMessage>>	basketMap When batch sending is enabled, the message will be stored to basketMap Send via asynchronous thread AbstractNettyRemotingClient.MergedSendRunnable isEnableClientBatchSendRequest()
protected boolean	enableClientBatchSendRequest
protected Object	mergeLock
protected Map<Integer,MergeMessage>	mergeMsgMap When sending message type is MergeMessage, will be stored to mergeMsgMap.

Fields inherited from class io.seata.core.rpc.netty.AbstractNettyRemoting

futures, idGenerator, isSending, lock, messageExecutor, nowMills, processorTable, rpcHooks, timerExecutor

Constructor Summary

Constructors

Constructor and Description
AbstractNettyRemotingClient(NettyClientConfig nettyClientConfig, io.netty.util.concurrent.EventExecutorGroup eventExecutorGroup, ThreadPoolExecutor messageExecutor, NettyPoolKey.TransactionRole transactionRole)

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	destroyChannel(String serverAddress, io.netty.channel.Channel channel) Destroy channel.
protected InetSocketAddress	doSelect(List<InetSocketAddress> list, Object msg)
io.seata.core.rpc.netty.NettyClientChannelManager	getClientChannelManager()
protected abstract Function<String,NettyPoolKey>	getPoolKeyFunction() Get pool key function.
protected abstract long	getRpcRequestTimeout() get Rpc Request Timeout
TransactionMessageHandler	getTransactionMessageHandler()
protected abstract String	getTransactionServiceGroup() Get transaction service group.
protected String	getXid(Object msg)
void	init()
protected abstract boolean	isEnableClientBatchSendRequest() Whether to enable batch sending of requests, hand over to subclass implementation.
protected String	loadBalance(String transactionServiceGroup, Object msg)
void	registerProcessor(int requestCode, RemotingProcessor processor, ExecutorService executor) register processor
void	sendAsyncRequest(io.netty.channel.Channel channel, Object msg) client send async request.
void	sendAsyncResponse(String serverAddress, RpcMessage rpcMessage, Object msg) client send async response.
Object	sendSyncRequest(io.netty.channel.Channel channel, Object msg) client send sync request.
Object	sendSyncRequest(Object msg) client send sync request.
void	setTransactionMessageHandler(TransactionMessageHandler transactionMessageHandler)

Methods inherited from class io.seata.core.rpc.netty.AbstractNettyRemoting

buildRequestMessage, buildResponseMessage, destroyChannel, doAfterRpcHooks, doBeforeRpcHooks, getAddressFromChannel, getAddressFromContext, getFutures, getGroup, getNextMessageId, processMessage, sendAsync, sendSync, setGroup

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.seata.core.rpc.RemotingClient

onRegisterMsgFail, onRegisterMsgSuccess

Field Detail

mergeLock

protected final Object mergeLock

mergeMsgMap

protected final Map<Integer,MergeMessage> mergeMsgMap

When sending message type is MergeMessage, will be stored to mergeMsgMap.

basketMap

protected final ConcurrentHashMap<String,BlockingQueue<RpcMessage>> basketMap

When batch sending is enabled, the message will be stored to basketMap Send via asynchronous thread AbstractNettyRemotingClient.MergedSendRunnable isEnableClientBatchSendRequest()

enableClientBatchSendRequest

protected volatile boolean enableClientBatchSendRequest

Constructor Detail

AbstractNettyRemotingClient

public AbstractNettyRemotingClient(NettyClientConfig nettyClientConfig,
                                   io.netty.util.concurrent.EventExecutorGroup eventExecutorGroup,
                                   ThreadPoolExecutor messageExecutor,
                                   NettyPoolKey.TransactionRole transactionRole)

Method Detail

init

public void init()

Overrides:

init in class AbstractNettyRemoting

sendSyncRequest

public Object sendSyncRequest(Object msg)
                       throws TimeoutException

Description copied from interface: RemotingClient

client send sync request. In this request, if RmNettyRemotingClient.isEnableClientBatchSendRequest() TmNettyRemotingClient.isEnableClientBatchSendRequest() is enabled, the message will be sent in batches.

Specified by:

sendSyncRequest in interface RemotingClient

Parameters:

msg - transaction message io.seata.core.protocol

Returns:

server result message

Throws:

TimeoutException - TimeoutException

sendSyncRequest

public Object sendSyncRequest(io.netty.channel.Channel channel,
                              Object msg)
                       throws TimeoutException

Description copied from interface: RemotingClient

client send sync request.

Specified by:

sendSyncRequest in interface RemotingClient

Parameters:

channel - client channel

msg - transaction message io.seata.core.protocol

Returns:

server result message

Throws:

TimeoutException - TimeoutException

sendAsyncRequest

public void sendAsyncRequest(io.netty.channel.Channel channel,
                             Object msg)

Description copied from interface: RemotingClient

client send async request.

Specified by:

sendAsyncRequest in interface RemotingClient

Parameters:

channel - client channel

msg - transaction message io.seata.core.protocol

sendAsyncResponse

public void sendAsyncResponse(String serverAddress,
                              RpcMessage rpcMessage,
                              Object msg)

Description copied from interface: RemotingClient

client send async response.

Specified by:

sendAsyncResponse in interface RemotingClient

Parameters:

serverAddress - server address

rpcMessage - rpc message from server request

msg - transaction message io.seata.core.protocol

registerProcessor

public void registerProcessor(int requestCode,
                              RemotingProcessor processor,
                              ExecutorService executor)

Description copied from interface: RemotingClient

register processor

Specified by:

registerProcessor in interface RemotingClient

Parameters:

requestCode - MessageType

processor - RemotingProcessor

executor - thread pool

destroyChannel

public void destroyChannel(String serverAddress,
                           io.netty.channel.Channel channel)

Description copied from class: AbstractNettyRemoting

Destroy channel.

Specified by:

destroyChannel in class AbstractNettyRemoting

Parameters:

serverAddress - the server address

channel - the channel

destroy

public void destroy()

Specified by:

destroy in interface Disposable

Overrides:

destroy in class AbstractNettyRemoting

setTransactionMessageHandler

public void setTransactionMessageHandler(TransactionMessageHandler transactionMessageHandler)

getTransactionMessageHandler

public TransactionMessageHandler getTransactionMessageHandler()

getClientChannelManager

public io.seata.core.rpc.netty.NettyClientChannelManager getClientChannelManager()

loadBalance

protected String loadBalance(String transactionServiceGroup,
                             Object msg)

doSelect

protected InetSocketAddress doSelect(List<InetSocketAddress> list,
                                     Object msg)
                              throws Exception

Throws:

Exception

getXid

protected String getXid(Object msg)

getPoolKeyFunction

protected abstract Function<String,NettyPoolKey> getPoolKeyFunction()

Get pool key function.

Returns:

lambda function

getTransactionServiceGroup

protected abstract String getTransactionServiceGroup()

Get transaction service group.

Returns:

transaction service group

isEnableClientBatchSendRequest

protected abstract boolean isEnableClientBatchSendRequest()

Whether to enable batch sending of requests, hand over to subclass implementation.

Returns:

true:enable, false:disable

getRpcRequestTimeout

protected abstract long getRpcRequestTimeout()

get Rpc Request Timeout

Returns:

the Rpc Request Timeout