com.baidu.brpc.protocol.nshead

类 NSHeadRpcProtocol

java.lang.Object

com.baidu.brpc.protocol.AbstractProtocol

com.baidu.brpc.protocol.nshead.NSHeadRpcProtocol

所有已实现的接口:

Protocol

直接已知子类:

NSHeadJsonProtocol, NSHeadProtobufProtocol

public abstract class NSHeadRpcProtocol
extends AbstractProtocol

nshead based protocol, the header format is NSHead

字段概要

字段

限定符和类型	字段和说明
protected String	encoding

从类继承的字段 com.baidu.brpc.protocol.AbstractProtocol

notEnoughDataException

构造器概要

构造器

构造器和说明
NSHeadRpcProtocol(String encoding)

方法概要

限定符和类型	方法和说明
NSHeadPacket	decode(io.netty.channel.ChannelHandlerContext ctx, DynamicCompositeByteBuf in, boolean isDecodingRequest) 客户端/服务端解析请求包成header+body buffer
abstract Object	decodeBody(io.netty.buffer.ByteBuf bodyBuf, RpcMethodInfo rpcMethodInfo)
Request	decodeRequest(Object packet) 服务端反序列化rpc请求
Response	decodeResponse(Object in, io.netty.channel.ChannelHandlerContext ctx) 客户端反序列化rpc响应
abstract byte[]	encodeBody(Object body, RpcMethodInfo rpcMethodInfo)
io.netty.buffer.ByteBuf	encodeRequest(Request request) 客户端序列化请求对象
io.netty.buffer.ByteBuf	encodeResponse(Request request, Response response) 服务端序列化返回结果。
boolean	returnChannelBeforeResponse() 连接被归还入池的时机

从类继承的方法 com.baidu.brpc.protocol.AbstractProtocol

afterResponseSent, beforeRequestSent, createRequest, createResponse, getRequest, getResponse, isCoexistence

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

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

字段详细资料

encoding

protected String encoding

构造器详细资料

NSHeadRpcProtocol

public NSHeadRpcProtocol(String encoding)

方法详细资料

encodeRequest

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

从接口复制的说明: Protocol

客户端序列化请求对象

参数:

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

抛出:

Exception - 序列化异常

decodeResponse

public Response decodeResponse(Object in,
                               io.netty.channel.ChannelHandlerContext ctx)
                        throws Exception

从接口复制的说明: Protocol

客户端反序列化rpc响应

参数:

in - header & body的buf

ctx - netty channel context

抛出:

Exception - 反序列化异常

encodeResponse

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

从接口复制的说明: Protocol

服务端序列化返回结果。

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

抛出:

Exception - 序列化异常

decodeRequest

public Request decodeRequest(Object packet)
                      throws Exception

从接口复制的说明: Protocol

服务端反序列化rpc请求

参数:

packet - header & body的buf

抛出:

Exception

returnChannelBeforeResponse

public boolean returnChannelBeforeResponse()

从接口复制的说明: Protocol

连接被归还入池的时机

指定者:

returnChannelBeforeResponse 在接口中 Protocol

覆盖:

returnChannelBeforeResponse 在类中 AbstractProtocol

返回:

true代表请求发送后立即归还连接，false表示收到响应后归还。

decode

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

从接口复制的说明: Protocol

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

in - 输入byte buf

返回:

header+body buffer

抛出:

BadSchemaException - header格式不对

TooBigDataException - body太大

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

encodeBody

public abstract byte[] encodeBody(Object body,
                                  RpcMethodInfo rpcMethodInfo)

decodeBody

public abstract Object decodeBody(io.netty.buffer.ByteBuf bodyBuf,
                                  RpcMethodInfo rpcMethodInfo)