Protocol (brpc-java 2.5.9 API)

所有已知子接口:

ServerPushProtocol

所有已知实现类:

AbstractProtocol, BaiduRpcProtocol, DefaultServerPushProtocol, HttpRpcProtocol, HuluRpcProtocol, NSHeadJsonProtocol, NSHeadProtobufProtocol, NSHeadRpcProtocol, PublicPbrpcProtocol, SofaRpcProtocol, StargateRpcProtocol
```
public interface Protocol
```
rpc协议接口，业务如果想实现一个自定义协议，需要实现该接口。 Created by huwenwei on 2017/9/22.

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`void`	`afterResponseSent(Request request, Response response, io.netty.channel.ChannelFuture channelFuture)` do something if needed after server channel writeAndFlush
`void`	`beforeRequestSent(Request request, RpcClient rpcClient, BrpcChannel channelGroup)` do something if needed before client send request
`Request`	`createRequest()` create a new request instance
`Response`	`createResponse()` create a new response instance
`Object`	`decode(io.netty.channel.ChannelHandlerContext ctx, DynamicCompositeByteBuf in, boolean isDecodingRequest)` 客户端/服务端解析请求包成header+body buffer
`Request`	`decodeRequest(Object packet)` 服务端反序列化rpc请求
`Response`	`decodeResponse(Object msg, io.netty.channel.ChannelHandlerContext ctx)` 客户端反序列化rpc响应
`io.netty.buffer.ByteBuf`	`encodeRequest(Request request)` 客户端序列化请求对象
`io.netty.buffer.ByteBuf`	`encodeResponse(Request request, Response response)` 服务端序列化返回结果。
`Request`	`getRequest()` get a reusable request instance from threadLocal or pool the request instance must be reset before reuse
`Response`	`getResponse()` get a reusable response instance from threadLocal or pool the response instance must be reset before reuse
`boolean`	`isCoexistence()` 该协议是否可以和其他协议共存。
`boolean`	`returnChannelBeforeResponse()` 连接被归还入池的时机

- 方法详细资料
  - decode
```
Object decode(io.netty.channel.ChannelHandlerContext ctx,
              DynamicCompositeByteBuf in,
              boolean isDecodingRequest)
       throws BadSchemaException,
              TooBigDataException,
              NotEnoughDataException
```
    客户端/服务端解析请求包成header+body buffer
    
    参数:
    
    in - 输入byte buf
    
    返回:
    
    header+body buffer
    
    抛出:
    
    BadSchemaException - header格式不对
    
    TooBigDataException - body太大
    
    NotEnoughDataException - 可读长度不够，由于粘包拆包问题。
  - isCoexistence
```
boolean isCoexistence()
```
    该协议是否可以和其他协议共存。
    
    返回:
    
    true可以共存，false不能共存。
  - createRequest
```
Request createRequest()
```
    create a new request instance
  - createResponse
```
Response createResponse()
```
    create a new response instance
  - getRequest
```
Request getRequest()
```
    get a reusable request instance from threadLocal or pool the request instance must be reset before reuse
  - getResponse
```
Response getResponse()
```
    get a reusable response instance from threadLocal or pool the response instance must be reset before reuse
  - encodeRequest
```
io.netty.buffer.ByteBuf encodeRequest(Request request)
                               throws Exception
```
    客户端序列化请求对象
    
    参数:
    
    request - 待发送给服务端的对象
    
    抛出:
    
    Exception - 序列化异常
  - beforeRequestSent
```
void beforeRequestSent(Request request,
                       RpcClient rpcClient,
                       BrpcChannel channelGroup)
```
    do something if needed before client send request
  - decodeResponse
```
Response decodeResponse(Object msg,
                        io.netty.channel.ChannelHandlerContext ctx)
                 throws Exception
```
    客户端反序列化rpc响应
    
    参数:
    
    msg - header & body的buf
    
    ctx - netty channel context
    
    抛出:
    
    Exception - 反序列化异常
  - returnChannelBeforeResponse
```
boolean returnChannelBeforeResponse()
```
    连接被归还入池的时机
    
    返回:
    
    true代表请求发送后立即归还连接，false表示收到响应后归还。
  - decodeRequest
```
Request decodeRequest(Object packet)
               throws Exception
```
    服务端反序列化rpc请求
    
    参数:
    
    packet - header & body的buf
    
    抛出:
    
    Exception
  - encodeResponse
```
io.netty.buffer.ByteBuf encodeResponse(Request request,
                                       Response response)
                                throws Exception
```
    服务端序列化返回结果。
    
    参数:
    
    response - 服务端要返回给客户端的对象
    
    抛出:
    
    Exception - 序列化异常
  - afterResponseSent
```
void afterResponseSent(Request request,
                       Response response,
                       io.netty.channel.ChannelFuture channelFuture)
```
    do something if needed after server channel writeAndFlush
    
    参数:
    
    channelFuture - the return value of writeAndFlush

接口 Protocol

方法概要

方法详细资料

decode

isCoexistence

createRequest

createResponse

getRequest

getResponse

encodeRequest

beforeRequestSent

decodeResponse

returnChannelBeforeResponse

decodeRequest

encodeResponse

afterResponseSent