com.baidu.brpc.protocol

接口 Protocol

所有已知实现类:

AbstractProtocol, BaiduRpcProtocol, HttpRpcProtocol, HuluRpcProtocol, NSHeadRpcProtocol, SofaRpcProtocol

public interface Protocol

rpc协议接口，业务如果想实现一个自定义协议，需要实现该接口。 Created by huwenwei on 2017/9/22.

方法概要

限定符和类型	方法和说明
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() 连接被归还入池的时机

方法详细资料

decode

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

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

参数:

in - 输入byte buf

返回:

header+body buffer

抛出:

BadSchemaException - header格式不对

TooBigDataException - body太大

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

encodeRequest

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

客户端序列化请求对象

参数:

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

抛出:

Exception - 序列化异常

decodeResponse

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

客户端反序列化rpc响应

参数:

packet - header & body的buf

ctx - netty channel context

抛出:

Exception - 反序列化异常

returnChannelBeforeResponse

boolean returnChannelBeforeResponse()

连接被归还入池的时机

返回:

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

decodeRequest

void decodeRequest(Object packet,
                   RpcRequest rpcRequest)
            throws Exception

服务端反序列化rpc请求

参数:

packet - header & body的buf

抛出:

Exception

encodeResponse

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

服务端序列化返回结果。

参数:

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

抛出:

Exception - 序列化异常

encodeHttpRequest

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

根据rpc request构建http request

参数:

rpcRequest -

返回:

抛出:

Exception

decodeHttpResponse

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

根据http response构建rpc response

参数:

httpResponse -

返回:

decodeHttpRequest

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

根据http request生成rpc request

参数:

httpRequest -

encodeHttpResponse

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

根据rpc response生成http response

参数:

rpcResponse -

返回: