com.baidu.brpc.protocol

类 AbstractProtocol

java.lang.Object

com.baidu.brpc.protocol.AbstractProtocol

所有已实现的接口:

Protocol

直接已知子类:

BaiduRpcProtocol, HttpRpcProtocol, HuluRpcProtocol, NSHeadRpcProtocol, SofaRpcProtocol

public abstract class AbstractProtocol
extends Object
implements Protocol

构造器概要

构造器

构造器和说明
AbstractProtocol()

方法概要

限定符和类型	方法和说明
Object	decode(DynamicCompositeByteBuf in) 客户端/服务端解析请求包成header+body buffer
void	decodeHttpRequest(io.netty.handler.codec.http.FullHttpRequest httpRequest, RpcRequest rpcRequest) 根据http request生成rpc request
RpcResponse	decodeHttpResponse(io.netty.handler.codec.http.FullHttpResponse httpResponse, io.netty.channel.ChannelHandlerContext ctx) 根据http response构建rpc response
void	decodeRequest(Object packet, RpcRequest rpcRequest) 服务端反序列化rpc请求
RpcResponse	decodeResponse(Object packet, io.netty.channel.ChannelHandlerContext ctx) 客户端反序列化rpc响应
io.netty.handler.codec.http.FullHttpRequest	encodeHttpRequest(RpcRequest rpcRequest) 根据rpc request构建http request
io.netty.handler.codec.http.FullHttpResponse	encodeHttpResponse(RpcRequest rpcRequest, RpcResponse rpcResponse) 根据rpc response生成http response
io.netty.buffer.ByteBuf	encodeRequest(RpcRequest rpcRequest) 客户端序列化请求对象
io.netty.buffer.ByteBuf	encodeResponse(RpcResponse rpcResponse) 服务端序列化返回结果。
boolean	returnChannelBeforeResponse() 连接被归还入池的时机

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

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

构造器详细资料

AbstractProtocol

public AbstractProtocol()

方法详细资料

encodeRequest

public io.netty.buffer.ByteBuf encodeRequest(RpcRequest rpcRequest)
                                      throws Exception

从接口复制的说明: Protocol

客户端序列化请求对象

指定者:

encodeRequest 在接口中 Protocol

参数:

rpcRequest - 待发送给服务端的对象

抛出:

Exception - 序列化异常

decode

public Object decode(DynamicCompositeByteBuf in)
              throws BadSchemaException,
                     TooBigDataException,
                     NotEnoughDataException

从接口复制的说明: Protocol

客户端/服务端解析请求包成header+body buffer

指定者:

decode 在接口中 Protocol

参数:

in - 输入byte buf

返回:

header+body buffer

抛出:

BadSchemaException - header格式不对

TooBigDataException - body太大

NotEnoughDataException - 可读长度不够，由于粘包拆包问题。

decodeResponse

public RpcResponse decodeResponse(Object packet,
                                  io.netty.channel.ChannelHandlerContext ctx)
                           throws Exception

从接口复制的说明: Protocol

客户端反序列化rpc响应

指定者:

decodeResponse 在接口中 Protocol

参数:

packet - header & body的buf

ctx - netty channel context

抛出:

Exception - 反序列化异常

decodeRequest

public void decodeRequest(Object packet,
                          RpcRequest rpcRequest)
                   throws Exception

从接口复制的说明: Protocol

服务端反序列化rpc请求

指定者:

decodeRequest 在接口中 Protocol

参数:

packet - header & body的buf

抛出:

Exception

encodeResponse

public io.netty.buffer.ByteBuf encodeResponse(RpcResponse rpcResponse)
                                       throws Exception

从接口复制的说明: Protocol

服务端序列化返回结果。

指定者:

encodeResponse 在接口中 Protocol

参数:

rpcResponse - 服务端要返回给客户端的对象

抛出:

Exception - 序列化异常

encodeHttpRequest

public io.netty.handler.codec.http.FullHttpRequest encodeHttpRequest(RpcRequest rpcRequest)
                                                              throws Exception

从接口复制的说明: Protocol

根据rpc request构建http request

指定者:

encodeHttpRequest 在接口中 Protocol

返回:

抛出:

Exception

decodeHttpResponse

public RpcResponse decodeHttpResponse(io.netty.handler.codec.http.FullHttpResponse httpResponse,
                                      io.netty.channel.ChannelHandlerContext ctx)

从接口复制的说明: Protocol

根据http response构建rpc response

指定者:

decodeHttpResponse 在接口中 Protocol

返回:

decodeHttpRequest

public void decodeHttpRequest(io.netty.handler.codec.http.FullHttpRequest httpRequest,
                              RpcRequest rpcRequest)

从接口复制的说明: Protocol

根据http request生成rpc request

指定者:

decodeHttpRequest 在接口中 Protocol

encodeHttpResponse

public io.netty.handler.codec.http.FullHttpResponse encodeHttpResponse(RpcRequest rpcRequest,
                                                                       RpcResponse rpcResponse)

从接口复制的说明: Protocol

根据rpc response生成http response

指定者:

encodeHttpResponse 在接口中 Protocol

返回:

returnChannelBeforeResponse

public boolean returnChannelBeforeResponse()

从接口复制的说明: Protocol

连接被归还入池的时机

指定者:

returnChannelBeforeResponse 在接口中 Protocol

返回:

true代表请求发送后立即归还连接，无需等待响应