com.baidu.brpc.protocol.standard

Class BaiduRpcProtocol

java.lang.Object

com.baidu.brpc.protocol.AbstractProtocol

com.baidu.brpc.protocol.standard.BaiduRpcProtocol

All Implemented Interfaces:

Protocol

public class BaiduRpcProtocol
extends AbstractProtocol

Notes on Baidu RPC Protocol:

• Header format is ["PRPC"][body_size][meta_size ], 12 bytes in total
• body_size and meta_size are in network byte order (big endian)
• Use service->full_name() and method_name to identify the service and method to call
• attachment_size is set iff request/response has attachment
• The following fields of rpc are not supported yet:
  • chunk_info

Created by huwenwei on 2017/9/22.

Field Summary

Fields inherited from class com.baidu.brpc.protocol.AbstractProtocol

notEnoughDataException

Constructor Summary

Constructors

Constructor and Description
BaiduRpcProtocol()

Method Summary

Modifier and Type	Method and Description
BaiduRpcDecodePacket	decode(io.netty.channel.ChannelHandlerContext ctx, DynamicCompositeByteBuf in, boolean isDecodingRequest) 客户端/服务端解析请求包成header+body buffer
Request	decodeRequest(Object packet) 服务端反序列化rpc请求
RpcResponse	decodeResponse(Object packet, io.netty.channel.ChannelHandlerContext ctx) 客户端反序列化rpc响应
protected io.netty.buffer.ByteBuf	encode(BaiduRpcEncodePacket packet)
io.netty.buffer.ByteBuf	encodeRequest(Request request) 客户端序列化请求对象
io.netty.buffer.ByteBuf	encodeResponse(Request request, Response response) 服务端序列化返回结果。
boolean	isCoexistence() 该协议是否可以和其他协议共存。

Methods inherited from class com.baidu.brpc.protocol.AbstractProtocol

afterResponseSent, createRequest, createResponse, getRequest, getResponse, returnChannelBeforeResponse, supportHeartbeat

Methods inherited from class java.lang.Object

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

Constructor Detail

BaiduRpcProtocol

public BaiduRpcProtocol()

Method Detail

encodeRequest

public io.netty.buffer.ByteBuf encodeRequest(Request request)
                                      throws Exception

Description copied from interface: Protocol

客户端序列化请求对象

Parameters:

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

Throws:

Exception - 序列化异常

decodeResponse

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

Description copied from interface: Protocol

客户端反序列化rpc响应

Parameters:

packet - header & body的buf

ctx - netty channel context

Throws:

Exception - 反序列化异常

decode

public BaiduRpcDecodePacket decode(io.netty.channel.ChannelHandlerContext ctx,
                                   DynamicCompositeByteBuf in,
                                   boolean isDecodingRequest)
                            throws BadSchemaException,
                                   TooBigDataException,
                                   NotEnoughDataException

Description copied from interface: Protocol

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

in - 输入byte buf

Returns:

header+body buffer

Throws:

BadSchemaException - header格式不对

TooBigDataException - body太大

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

decodeRequest

public Request decodeRequest(Object packet)
                      throws Exception

Description copied from interface: Protocol

服务端反序列化rpc请求

Parameters:

packet - header & body的buf

Throws:

Exception

encodeResponse

public io.netty.buffer.ByteBuf encodeResponse(Request request,
                                              Response response)
                                       throws Exception

Description copied from interface: Protocol

服务端序列化返回结果。

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

Throws:

Exception - 序列化异常

encode

protected io.netty.buffer.ByteBuf encode(BaiduRpcEncodePacket packet)
                                  throws Exception

Throws:

Exception

isCoexistence

public boolean isCoexistence()

Description copied from interface: Protocol

该协议是否可以和其他协议共存。

Specified by:

isCoexistence in interface Protocol

Overrides:

isCoexistence in class AbstractProtocol

Returns:

true可以共存，false不能共存。