RmRpcClient (seata-core 0.6.1 0.6.1 API)

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.channel.ChannelDuplexHandler
    - - io.seata.core.rpc.netty.AbstractRpcRemoting
      - io.seata.core.rpc.netty.AbstractRpcRemotingClient
        
        io.seata.core.rpc.netty.RmRpcClient

所有已实现的接口:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler, ClientMessageSender, Disposable, RegisterMsgListener, RemotingService
```
@ChannelHandler.Sharable
public final class RmRpcClient
extends AbstractRpcRemotingClient
```
The type Rm rpc client.

作者:

jimin.jm @alibaba-inc.com

嵌套类概要
- 从类继承的嵌套类/接口 io.seata.core.rpc.netty.AbstractRpcRemotingClient
  AbstractRpcRemotingClient.MergedSendRunnable
- 从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler
  io.netty.channel.ChannelHandler.Sharable

字段概要
- 从类继承的字段 io.seata.core.rpc.netty.AbstractRpcRemotingClient
  clientMessageListener, nettyClientKeyPool
- 从类继承的字段 io.seata.core.rpc.netty.AbstractRpcRemoting
  basketMap, channelHandlers, futures, isSending, mergeLock, mergeMsgMap, messageExecutor, nowMills, timerExecutor

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`protected io.netty.channel.Channel`	`connect(String serverAddress)` Connect channel.
`void`	`destroyChannel(String serverAddress, io.netty.channel.Channel channel)` Destroy channel.
`void`	`exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)`
`String`	`getCustomerKeys()` Gets customer keys.
`static RmRpcClient`	`getInstance()` Gets instance.
`static RmRpcClient`	`getInstance(String applicationId, String transactionServiceGroup)` Gets instance.
`String`	`getMergedResourceKeys(ResourceManager resourceManager)` Gets merged resource keys.
`protected org.apache.commons.pool.impl.GenericKeyedObjectPool.Config`	`getNettyPoolConfig()` Gets netty pool config.
`protected NettyPoolKey.TransactionRole`	`getTransactionRole()` Gets transaction role.
`void`	`init()` Init.
`void`	`onRegisterMsgFail(String serverAddress, io.netty.channel.Channel channel, Object response, AbstractMessage requestMessage)` On register msg fail.
`void`	`onRegisterMsgSuccess(String serverAddress, io.netty.channel.Channel channel, Object response, AbstractMessage requestMessage)` On register msg success.
`void`	`registerResource(String resourceGroupId, String resourceId)` Register new db key.
`protected void`	`releaseChannel(io.netty.channel.Channel channel, String serverAddress)` Release channel.
`Object`	`sendMsgWithResponse(Object msg)` Send msg with response object.
`Object`	`sendMsgWithResponse(Object msg, long timeout)` Send msg with response object.
`Object`	`sendMsgWithResponse(String serverAddress, Object msg, long timeout)` Send msg with response object.
`void`	`sendResponse(long msgId, String serverAddress, Object msg)` Send response.
`void`	`setApplicationId(String applicationId)` Sets application id.
`void`	`setCustomerKeys(String customerKeys)` Sets customer keys.
`void`	`setResourceManager(ResourceManager resourceManager)` Sets resource manager.
`void`	`setTransactionServiceGroup(String transactionServiceGroup)` Sets transaction service group.
`void`	`userEventTriggered(io.netty.channel.ChannelHandlerContext ctx, Object evt)`

从类继承的方法 io.seata.core.rpc.netty.AbstractRpcRemotingClient
channelInactive, channelRead, destroy, dispatch, getAvailServerList, getClientMessageListener, getNewChannel, getThreadPrefix, loadBalance, reconnect, setClientMessageListener, shutdown, start

从类继承的方法 io.seata.core.rpc.netty.AbstractRpcRemoting
addChannelPipelineLast, channelWritabilityChanged, close, destroyChannel, getAddressFromChannel, getAddressFromContext, getGroup, sendAsyncRequestWithoutResponse, sendAsyncRequestWithResponse, sendAsyncRequestWithResponse, sendRequest, sendResponse, setChannelHandlers, setGroup

从类继承的方法 io.netty.channel.ChannelDuplexHandler
bind, connect, deregister, disconnect, flush, read, write

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelReadComplete, channelRegistered, channelUnregistered

从类继承的方法 io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, handlerAdded, handlerRemoved, isSharable

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 io.netty.channel.ChannelHandler
handlerAdded, handlerRemoved

- 方法详细资料
  - setResourceManager
```
public void setResourceManager(ResourceManager resourceManager)
```
    Sets resource manager.
    
    参数:
    
    resourceManager - the resource manager
  - getInstance
```
public static RmRpcClient getInstance(String applicationId,
                                      String transactionServiceGroup)
```
    Gets instance.
    
    参数:
    
    applicationId - the application id
    
    transactionServiceGroup - the transaction service group
    
    返回:
    
    the instance
  - getInstance
```
public static RmRpcClient getInstance()
```
    Gets instance.
    
    返回:
    
    the instance
  - init
```
public void init()
```
    从类复制的说明: AbstractRpcRemoting
    
    Init.
    
    覆盖:
    
    init 在类中 AbstractRpcRemotingClient
  - setApplicationId
```
public void setApplicationId(String applicationId)
```
    Sets application id.
    
    参数:
    
    applicationId - the application id
  - setTransactionServiceGroup
```
public void setTransactionServiceGroup(String transactionServiceGroup)
```
    Sets transaction service group.
    
    参数:
    
    transactionServiceGroup - the transaction service group
  - getNettyPoolConfig
```
protected org.apache.commons.pool.impl.GenericKeyedObjectPool.Config getNettyPoolConfig()
```
    从类复制的说明: AbstractRpcRemotingClient
    
    Gets netty pool config.
    
    指定者:
    
    getNettyPoolConfig 在类中 AbstractRpcRemotingClient
    
    返回:
    
    the netty pool config
  - getTransactionRole
```
protected NettyPoolKey.TransactionRole getTransactionRole()
```
    从类复制的说明: AbstractRpcRemotingClient
    
    Gets transaction role.
    
    指定者:
    
    getTransactionRole 在类中 AbstractRpcRemotingClient
    
    返回:
    
    the transaction role
  - sendMsgWithResponse
```
public Object sendMsgWithResponse(Object msg,
                                  long timeout)
                           throws TimeoutException
```
    从接口复制的说明: ClientMessageSender
    
    Send msg with response object.
    
    参数:
    
    msg - the msg
    
    timeout - the timeout
    
    返回:
    
    the object
    
    抛出:
    
    TimeoutException - the timeout exception
  - sendMsgWithResponse
```
public Object sendMsgWithResponse(String serverAddress,
                                  Object msg,
                                  long timeout)
                           throws TimeoutException
```
    从接口复制的说明: ClientMessageSender
    
    Send msg with response object.
    
    参数:
    
    serverAddress - the server address
    
    msg - the msg
    
    timeout - the timeout
    
    返回:
    
    the object
    
    抛出:
    
    TimeoutException - the timeout exception
  - sendMsgWithResponse
```
public Object sendMsgWithResponse(Object msg)
                           throws TimeoutException
```
    从接口复制的说明: ClientMessageSender
    
    Send msg with response object.
    
    参数:
    
    msg - the msg
    
    返回:
    
    the object
    
    抛出:
    
    TimeoutException - the timeout exception
  - userEventTriggered
```
public void userEventTriggered(io.netty.channel.ChannelHandlerContext ctx,
                               Object evt)
```
    指定者:
    
    userEventTriggered 在接口中 io.netty.channel.ChannelInboundHandler
    
    覆盖:
    
    userEventTriggered 在类中 io.netty.channel.ChannelInboundHandlerAdapter
  - releaseChannel
```
protected void releaseChannel(io.netty.channel.Channel channel,
                              String serverAddress)
```
    从类复制的说明: AbstractRpcRemotingClient
    
    Release channel.
    
    指定者:
    
    releaseChannel 在类中 AbstractRpcRemotingClient
    
    参数:
    
    channel - the channel
    
    serverAddress - the server address
  - connect
```
protected io.netty.channel.Channel connect(String serverAddress)
```
    从类复制的说明: AbstractRpcRemotingClient
    
    Connect channel.
    
    指定者:
    
    connect 在类中 AbstractRpcRemotingClient
    
    参数:
    
    serverAddress - the server address
    
    返回:
    
    the channel
  - exceptionCaught
```
public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                            Throwable cause)
                     throws Exception
```
    指定者:
    
    exceptionCaught 在接口中 io.netty.channel.ChannelHandler
    
    指定者:
    
    exceptionCaught 在接口中 io.netty.channel.ChannelInboundHandler
    
    覆盖:
    
    exceptionCaught 在类中 AbstractRpcRemoting
    
    抛出:
    
    Exception
  - registerResource
```
public void registerResource(String resourceGroupId,
                             String resourceId)
```
    Register new db key.
    
    参数:
    
    resourceGroupId - the resource group id
    
    resourceId - the db key
  - sendResponse
```
public void sendResponse(long msgId,
                         String serverAddress,
                         Object msg)
```
    从接口复制的说明: ClientMessageSender
    
    Send response.
    
    参数:
    
    msgId - the msg id
    
    serverAddress - the server address
    
    msg - the msg
  - getCustomerKeys
```
public String getCustomerKeys()
```
    Gets customer keys.
    
    返回:
    
    the customer keys
  - setCustomerKeys
```
public void setCustomerKeys(String customerKeys)
```
    Sets customer keys.
    
    参数:
    
    customerKeys - the customer keys
  - onRegisterMsgSuccess
```
public void onRegisterMsgSuccess(String serverAddress,
                                 io.netty.channel.Channel channel,
                                 Object response,
                                 AbstractMessage requestMessage)
```
    从接口复制的说明: RegisterMsgListener
    
    On register msg success.
    
    参数:
    
    serverAddress - the server address
    
    channel - the channel
    
    response - the response
    
    requestMessage - the request message
  - getMergedResourceKeys
```
public String getMergedResourceKeys(ResourceManager resourceManager)
```
    Gets merged resource keys.
    
    参数:
    
    resourceManager - the resource manager
    
    返回:
    
    the merged resource keys
  - onRegisterMsgFail
```
public void onRegisterMsgFail(String serverAddress,
                              io.netty.channel.Channel channel,
                              Object response,
                              AbstractMessage requestMessage)
```
    从接口复制的说明: RegisterMsgListener
    
    On register msg fail.
    
    参数:
    
    serverAddress - the server address
    
    channel - the channel
    
    response - the response
    
    requestMessage - the request message
  - destroyChannel
```
public void destroyChannel(String serverAddress,
                           io.netty.channel.Channel channel)
```
    从类复制的说明: AbstractRpcRemoting
    
    Destroy channel.
    
    指定者:
    
    destroyChannel 在类中 AbstractRpcRemoting
    
    参数:
    
    serverAddress - the server address
    
    channel - the channel

类 RmRpcClient

嵌套类概要

从类继承的嵌套类/接口 io.seata.core.rpc.netty.AbstractRpcRemotingClient

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

字段概要

从类继承的字段 io.seata.core.rpc.netty.AbstractRpcRemotingClient

从类继承的字段 io.seata.core.rpc.netty.AbstractRpcRemoting

方法概要

从类继承的方法 io.seata.core.rpc.netty.AbstractRpcRemotingClient

从类继承的方法 io.seata.core.rpc.netty.AbstractRpcRemoting

从类继承的方法 io.netty.channel.ChannelDuplexHandler

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

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

从接口继承的方法 io.netty.channel.ChannelHandler

方法详细资料

setResourceManager

getInstance

getInstance

init

setApplicationId

setTransactionServiceGroup

getNettyPoolConfig

getTransactionRole

sendMsgWithResponse

sendMsgWithResponse

sendMsgWithResponse

userEventTriggered

releaseChannel

connect

exceptionCaught

registerResource

sendResponse

getCustomerKeys

setCustomerKeys

onRegisterMsgSuccess

getMergedResourceKeys

onRegisterMsgFail

destroyChannel