com.alipay.sofa.rpc.transport.bolt

类 BoltClientTransport

java.lang.Object

com.alipay.sofa.rpc.transport.ClientTransport

com.alipay.sofa.rpc.transport.bolt.BoltClientTransport

@Extension(value="bolt")
public class BoltClientTransport
extends ClientTransport

注意，bolt的实现只支持长连接共享模式。

字段概要

字段

限定符和类型	字段和说明
protected com.alipay.remoting.Connection	connection Connection的实时状态 因为一个url在bolt里对应多个connect的，但是我们禁用，只保留一个
protected static com.alipay.sofa.rpc.transport.bolt.BoltClientConnectionManager	connectionManager Connection manager for reuse connection
protected AtomicInteger	currentRequests 正在发送的调用数量
protected static com.alipay.remoting.rpc.RpcClient	RPC_CLIENT Bolt rpc client
protected com.alipay.remoting.Url	url bolt需要的URL的缓存

从类继承的字段 com.alipay.sofa.rpc.transport.ClientTransport

transportConfig

构造器概要

构造器

限定符	构造器和说明
protected	BoltClientTransport(ClientTransportConfig transportConfig) Instant BoltClientTransport

方法概要

方法

限定符和类型	方法和说明
protected void	afterSend(RpcInternalContext context, com.alipay.remoting.InvokeContext invokeContext, SofaRequest request) 调用后设置一些属性（注意，在异步的情况较多下）
ResponseFuture	asyncSend(SofaRequest request, int timeout) 异步调用
protected void	beforeSend(RpcInternalContext context, SofaRequest request) 调用前设置一些属性
protected void	checkConnection()
void	connect() 建立长连接
protected com.alipay.remoting.Url	convertProviderToUrl(ClientTransportConfig transportConfig, ProviderInfo providerInfo) For convert provider to bolt url.
protected SofaRpcException	convertToRpcException(Exception e) 转换调用出现的异常为RPC异常
protected com.alipay.remoting.InvokeContext	createInvokeContext(SofaRequest request)
int	currentRequests() 当前请求数
void	destroy() 销毁（最好是通过工厂模式销毁，这样可以清理缓存）
void	disconnect() 断开连接
protected ResponseFuture	doInvokeAsync(SofaRequest request, RpcInternalContext rpcContext, com.alipay.remoting.InvokeContext invokeContext, int timeoutMillis) 异步调用
protected SofaResponse	doInvokeSync(SofaRequest request, com.alipay.remoting.InvokeContext invokeContext, int timeoutMillis) 同步调用
protected void	doOneWay(SofaRequest request, com.alipay.remoting.InvokeContext invokeContext, int timeoutMillis) 同步调用
AbstractChannel	getChannel() 得到长连接
void	handleRpcRequest(SofaRequest request) 客户端收到服务端的请求，可能是服务端Callback
boolean	isAvailable() 是否可用（有可用的长连接）
InetSocketAddress	localAddress() 本地地址
void	oneWaySend(SofaRequest request, int timeout) 单向调用
protected void	putToContextIfNotNull(com.alipay.remoting.InvokeContext invokeContext, String oldKey, RpcInternalContext context, String key)
void	receiveRpcResponse(SofaResponse response) 客户端收到异步响应
InetSocketAddress	remoteAddress() 远程地址
void	setChannel(AbstractChannel channel) 设置长连接
SofaResponse	syncSend(SofaRequest request, int timeout) 同步调用

从类继承的方法 com.alipay.sofa.rpc.transport.ClientTransport

getConfig

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

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

字段详细资料

RPC_CLIENT

protected static final com.alipay.remoting.rpc.RpcClient RPC_CLIENT

Bolt rpc client

connectionManager

protected static com.alipay.sofa.rpc.transport.bolt.BoltClientConnectionManager connectionManager

Connection manager for reuse connection

从以下版本开始:

5.4.0

url

protected final com.alipay.remoting.Url url

bolt需要的URL的缓存

connection

protected volatile com.alipay.remoting.Connection connection

Connection的实时状态
因为一个url在bolt里对应多个connect的，但是我们禁用，只保留一个

currentRequests

protected volatile AtomicInteger currentRequests

正在发送的调用数量

构造器详细资料

BoltClientTransport

protected BoltClientTransport(ClientTransportConfig transportConfig)

Instant BoltClientTransport

参数:

transportConfig - 客户端配置

方法详细资料

convertProviderToUrl

protected com.alipay.remoting.Url convertProviderToUrl(ClientTransportConfig transportConfig,
                                           ProviderInfo providerInfo)

For convert provider to bolt url.

参数:

transportConfig - ClientTransportConfig

providerInfo - ProviderInfo

返回:

Bolt Url

connect

public void connect()

从类复制的说明: ClientTransport

建立长连接

指定者:

connect 在类中 ClientTransport

disconnect

public void disconnect()

从类复制的说明: ClientTransport

断开连接

指定者:

disconnect 在类中 ClientTransport

destroy

public void destroy()

从类复制的说明: ClientTransport

销毁（最好是通过工厂模式销毁，这样可以清理缓存）

指定者:

destroy 在类中 ClientTransport

isAvailable

public boolean isAvailable()

从类复制的说明: ClientTransport

是否可用（有可用的长连接）

指定者:

isAvailable 在类中 ClientTransport

返回:

the boolean

setChannel

public void setChannel(AbstractChannel channel)

从类复制的说明: ClientTransport

设置长连接

指定者:

setChannel 在类中 ClientTransport

参数:

channel - the channel

getChannel

public AbstractChannel getChannel()

从类复制的说明: ClientTransport

得到长连接

指定者:

getChannel 在类中 ClientTransport

返回:

channel

currentRequests

public int currentRequests()

从类复制的说明: ClientTransport

当前请求数

指定者:

currentRequests 在类中 ClientTransport

返回:

当前请求数 int

asyncSend

public ResponseFuture asyncSend(SofaRequest request,
                       int timeout)
                         throws SofaRpcException

从类复制的说明: ClientTransport

异步调用

指定者:

asyncSend 在类中 ClientTransport

参数:

request - 消息

timeout - 超时时间

返回:

异步Future response future

抛出:

SofaRpcException - SofaRpcException

doInvokeAsync

protected ResponseFuture doInvokeAsync(SofaRequest request,
                           RpcInternalContext rpcContext,
                           com.alipay.remoting.InvokeContext invokeContext,
                           int timeoutMillis)
                                throws com.alipay.remoting.exception.RemotingException,
                                       InterruptedException

异步调用

参数:

request - 请求对象

rpcContext - RPC内置上下文

invokeContext - 调用上下文

timeoutMillis - 超时时间（毫秒）

抛出:

com.alipay.remoting.exception.RemotingException - 远程调用异常

InterruptedException - 中断异常

从以下版本开始:

5.2.0

syncSend

public SofaResponse syncSend(SofaRequest request,
                    int timeout)
                      throws SofaRpcException

从类复制的说明: ClientTransport

同步调用

指定者:

syncSend 在类中 ClientTransport

参数:

request - 消息

timeout - 超时时间

返回:

SofaResponse base message

抛出:

SofaRpcException - SofaRpcException

doInvokeSync

protected SofaResponse doInvokeSync(SofaRequest request,
                        com.alipay.remoting.InvokeContext invokeContext,
                        int timeoutMillis)
                             throws com.alipay.remoting.exception.RemotingException,
                                    InterruptedException

同步调用

参数:

request - 请求对象

invokeContext - 调用上下文

timeoutMillis - 超时时间（毫秒）

返回:

返回对象

抛出:

com.alipay.remoting.exception.RemotingException - 远程调用异常

InterruptedException - 中断异常

从以下版本开始:

5.2.0

oneWaySend

public void oneWaySend(SofaRequest request,
              int timeout)
                throws SofaRpcException

从类复制的说明: ClientTransport

单向调用

指定者:

oneWaySend 在类中 ClientTransport

参数:

request - 消息

timeout - 超时时间

抛出:

SofaRpcException - SofaRpcException

doOneWay

protected void doOneWay(SofaRequest request,
            com.alipay.remoting.InvokeContext invokeContext,
            int timeoutMillis)
                 throws com.alipay.remoting.exception.RemotingException,
                        InterruptedException

同步调用

参数:

request - 请求对象

invokeContext - 调用上下文

timeoutMillis - 超时时间（毫秒）

抛出:

com.alipay.remoting.exception.RemotingException - 远程调用异常

InterruptedException - 中断异常

从以下版本开始:

5.2.0

convertToRpcException

protected SofaRpcException convertToRpcException(Exception e)

转换调用出现的异常为RPC异常

参数:

e - 异常

返回:

RPC异常

createInvokeContext

protected com.alipay.remoting.InvokeContext createInvokeContext(SofaRequest request)

beforeSend

protected void beforeSend(RpcInternalContext context,
              SofaRequest request)

调用前设置一些属性

参数:

context - RPC上下文

request - 请求对象

afterSend

protected void afterSend(RpcInternalContext context,
             com.alipay.remoting.InvokeContext invokeContext,
             SofaRequest request)

调用后设置一些属性（注意，在异步的情况较多下）

参数:

context - RPC上下文

invokeContext - bolt调用上下文

request - 请求对象

receiveRpcResponse

public void receiveRpcResponse(SofaResponse response)

从类复制的说明: ClientTransport

客户端收到异步响应

指定者:

receiveRpcResponse 在类中 ClientTransport

参数:

response - the response

handleRpcRequest

public void handleRpcRequest(SofaRequest request)

从类复制的说明: ClientTransport

客户端收到服务端的请求，可能是服务端Callback

指定者:

handleRpcRequest 在类中 ClientTransport

参数:

request - the request

remoteAddress

public InetSocketAddress remoteAddress()

从类复制的说明: ClientTransport

远程地址

指定者:

remoteAddress 在类中 ClientTransport

返回:

远程地址，一般是服务端地址

localAddress

public InetSocketAddress localAddress()

从类复制的说明: ClientTransport

本地地址

指定者:

localAddress 在类中 ClientTransport

返回:

本地地址，一般是客户端地址

checkConnection

protected void checkConnection()
                        throws SofaRpcException

抛出:

SofaRpcException

putToContextIfNotNull

protected void putToContextIfNotNull(com.alipay.remoting.InvokeContext invokeContext,
                         String oldKey,
                         RpcInternalContext context,
                         String key)