DefaultServerPushProtocol (brpc-java-communication 3.0.1 API)

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

All Implemented Interfaces:: Protocol, ServerPushProtocol

public class DefaultServerPushProtocol
extends Object
implements ServerPushProtocol

Field Summary

Fields
Modifier and Type Field and Description

protected String encoding

Fields
Modifier and Type	Field and Description
`protected String`	`encoding`

Constructor Summary

Constructors
Constructor and Description

DefaultServerPushProtocol(String encoding)

Constructors
Constructor and Description
`DefaultServerPushProtocol(String encoding)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterResponseSent(Request request, Response response, io.netty.channel.ChannelFuture channelFuture)` do something if needed after server channel writeAndFlush
`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()` 连接被归还入池的时机
`boolean`	`supportHeartbeat()` check if the protocol supports heartbeat packet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - encoding
```
protected String encoding
```
- Constructor Detail
  - DefaultServerPushProtocol
```
public DefaultServerPushProtocol(String encoding)
```
- Method Detail
  - encodeRequest
```
public io.netty.buffer.ByteBuf encodeRequest(Request request)
                                      throws Exception
```
    Description copied from interface: Protocol
    
    客户端序列化请求对象
    
    Specified by:
    
    encodeRequest in interface Protocol
    
    Parameters:
    
    request - 待发送给服务端的对象
    
    Throws:
    
    Exception - 序列化异常
  - decodeServerPushResponse
```
public Response decodeServerPushResponse(Object in,
                                         io.netty.channel.ChannelHandlerContext ctx)
```
    decode 从客户端返回的 serverPushResponse
    
    Specified by:
    
    decodeServerPushResponse in interface ServerPushProtocol
    
    Parameters:
    
    in -
    
    ctx -
    
    Returns:
    
    Throws:
    
    Exception
  - decodeResponse
```
public Response decodeResponse(Object in,
                               io.netty.channel.ChannelHandlerContext ctx)
                        throws Exception
```
    Description copied from interface: Protocol
    
    客户端反序列化rpc响应
    
    Specified by:
    
    decodeResponse in interface Protocol
    
    Parameters:
    
    in - header & body的buf
    
    ctx - netty channel context
    
    Throws:
    
    Exception - 反序列化异常
  - encodeResponse
```
public io.netty.buffer.ByteBuf encodeResponse(Request request,
                                              Response response)
                                       throws Exception
```
    Description copied from interface: Protocol
    
    服务端序列化返回结果。
    
    Specified by:
    
    encodeResponse in interface Protocol
    
    response - 服务端要返回给客户端的对象
    
    Throws:
    
    Exception - 序列化异常
  - afterResponseSent
```
public void afterResponseSent(Request request,
                              Response response,
                              io.netty.channel.ChannelFuture channelFuture)
```
    Description copied from interface: Protocol
    
    do something if needed after server channel writeAndFlush
    
    Specified by:
    
    afterResponseSent in interface Protocol
    
    channelFuture - the return value of writeAndFlush
  - decodeRequest
```
public Request decodeRequest(Object packet)
                      throws Exception
```
    Description copied from interface: Protocol
    
    服务端反序列化rpc请求
    
    Specified by:
    
    decodeRequest in interface Protocol
    
    Parameters:
    
    packet - header & body的buf
    
    Throws:
    
    Exception
  - returnChannelBeforeResponse
```
public boolean returnChannelBeforeResponse()
```
    Description copied from interface: Protocol
    
    连接被归还入池的时机
    
    Specified by:
    
    returnChannelBeforeResponse in interface Protocol
    
    Returns:
    
    true代表请求发送后立即归还连接，false表示收到响应后归还。
  - decode
```
public DefaultServerPushPacket decode(io.netty.channel.ChannelHandlerContext ctx,
                                      DynamicCompositeByteBuf in,
                                      boolean isDecodingRequest)
                               throws BadSchemaException,
                                      TooBigDataException,
                                      NotEnoughDataException
```
    Description copied from interface: Protocol
    
    客户端/服务端解析请求包成header+body buffer
    
    Specified by:
    
    decode in interface Protocol
    
    in - 输入byte buf
    
    Returns:
    
    header+body buffer
    
    Throws:
    
    BadSchemaException - header格式不对
    
    TooBigDataException - body太大
    
    NotEnoughDataException - 可读长度不够，由于粘包拆包问题。
  - decodeBodyByteBuf
```
public SPBody decodeBodyByteBuf(io.netty.buffer.ByteBuf bodyByteBuf)
```
  - createRequest
```
public Request createRequest()
```
    Description copied from interface: Protocol
    
    create a new request instance
    
    Specified by:
    
    createRequest in interface Protocol
  - createResponse
```
public Response createResponse()
```
    Description copied from interface: Protocol
    
    create a new response instance
    
    Specified by:
    
    createResponse in interface Protocol
  - getRequest
```
public Request getRequest()
```
    Description copied from interface: Protocol
    
    get a reusable request instance from threadLocal or pool the request instance must be reset before reuse
    
    Specified by:
    
    getRequest in interface Protocol
  - getResponse
```
public Response getResponse()
```
    Description copied from interface: Protocol
    
    get a reusable response instance from threadLocal or pool the response instance must be reset before reuse
    
    Specified by:
    
    getResponse in interface Protocol
  - isCoexistence
```
public boolean isCoexistence()
```
    Description copied from interface: Protocol
    
    该协议是否可以和其他协议共存。
    
    Specified by:
    
    isCoexistence in interface Protocol
    
    Returns:
    
    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()
```
    Specified by:
    
    createSPHead in interface ServerPushProtocol
  - headFromByteBuf
```
public DefaultSPHead headFromByteBuf(io.netty.buffer.ByteBuf buf)
                              throws BadSchemaException
```
    Specified by:
    
    headFromByteBuf in interface ServerPushProtocol
    
    Throws:
    
    BadSchemaException
  - headToBytes
```
public io.netty.buffer.ByteBuf headToBytes(SPHead spHead)
```
    Specified by:
    
    headToBytes in interface ServerPushProtocol
  - supportHeartbeat
```
public boolean supportHeartbeat()
```
    Description copied from interface: Protocol
    
    check if the protocol supports heartbeat packet
    
    Specified by:
    
    supportHeartbeat in interface Protocol

Class DefaultServerPushProtocol

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

encoding

Constructor Detail

DefaultServerPushProtocol

Method Detail

encodeRequest

decodeServerPushResponse

decodeResponse

encodeResponse

afterResponseSent

decodeRequest

returnChannelBeforeResponse

decode

decodeBodyByteBuf

createRequest

createResponse

getRequest

getResponse

isCoexistence

encodeRequestBody

encodeResponseBody

decodeRequestBody

createSPHead

headFromByteBuf

headToBytes

supportHeartbeat