DefaultServerPushProtocol (brpc-java 2.5.9 API)

java.lang.Object
- com.baidu.brpc.protocol.push.impl.DefaultServerPushProtocol

所有已实现的接口:: Protocol, ServerPushProtocol

public class DefaultServerPushProtocol
extends Object
implements ServerPushProtocol

字段概要

字段
限定符和类型字段和说明

protected String encoding

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

构造器概要

构造器
构造器和说明

DefaultServerPushProtocol(String encoding)

构造器
构造器和说明
`DefaultServerPushProtocol(String encoding)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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
`SPHead`	`createSPHead()`
`DefaultServerPushPacket`	`decode(io.netty.channel.ChannelHandlerContext ctx, DynamicCompositeByteBuf in, boolean isDecodingRequest)` 客户端/服务端解析请求包成header+body buffer
`SPBody`	`decodeBodyByteBuf(io.netty.buffer.ByteBuf bodyByteBuf)`
`Request`	`decodeRequest(Object packet)` 服务端反序列化rpc请求
`void`	`decodeRequestBody(SPBody body, Request request)`
`Response`	`decodeResponse(Object in, io.netty.channel.ChannelHandlerContext ctx)` 客户端反序列化rpc响应
`Response`	`decodeServerPushResponse(Object in, io.netty.channel.ChannelHandlerContext ctx)` decode 从客户端返回的 serverPushResponse
`io.netty.buffer.ByteBuf`	`encodeRequest(Request request)` 客户端序列化请求对象
`io.netty.buffer.ByteBuf`	`encodeRequestBody(Request request, RpcMethodInfo rpcMethodInfo)`
`io.netty.buffer.ByteBuf`	`encodeResponse(Request request, Response response)` 服务端序列化返回结果。
`io.netty.buffer.ByteBuf`	`encodeResponseBody(Object result, RpcMethodInfo rpcMethodInfo)`
`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
`DefaultSPHead`	`headFromByteBuf(io.netty.buffer.ByteBuf buf)`
`io.netty.buffer.ByteBuf`	`headToBytes(SPHead spHead)`
`boolean`	`isCoexistence()` 该协议是否可以和其他协议共存。
`boolean`	`returnChannelBeforeResponse()` 连接被归还入池的时机

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

类 DefaultServerPushProtocol

字段概要

构造器概要

方法概要

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

字段详细资料

encoding

构造器详细资料

DefaultServerPushProtocol

方法详细资料

encodeRequest

beforeRequestSent

decodeServerPushResponse

decodeResponse

encodeResponse

afterResponseSent

decodeRequest

returnChannelBeforeResponse

decode

decodeBodyByteBuf

createRequest

createResponse

getRequest

getResponse

isCoexistence

encodeRequestBody

encodeResponseBody

decodeRequestBody

createSPHead

headFromByteBuf

headToBytes