com.baidu.brpc.protocol

Class AbstractProtocol

java.lang.Object

com.baidu.brpc.protocol.AbstractProtocol

All Implemented Interfaces:

Protocol

Direct Known Subclasses:

BaiduRpcProtocol, DubboRpcProtocol, HttpRpcProtocol, HuluRpcProtocol, NSHeadRpcProtocol, PublicPbrpcProtocol, SofaRpcProtocol, StargateRpcProtocol

public abstract class AbstractProtocol
extends Object
implements Protocol

An abstract protocol used to simplify tcp protocol implementations. Http protocol implementations extended this class need to override most methods, or implements Protocol interface directly.

Field Summary

Fields

Modifier and Type	Field and Description
protected static NotEnoughDataException	notEnoughDataException

Constructor Summary

Constructors

Constructor and Description
AbstractProtocol()

Method Summary

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
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() 连接被归还入池的时机
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

Methods inherited from interface com.baidu.brpc.protocol.Protocol

decode, decodeRequest, decodeResponse, encodeRequest, encodeResponse

Field Detail

notEnoughDataException

protected static NotEnoughDataException notEnoughDataException

Constructor Detail

AbstractProtocol

public AbstractProtocol()

Method Detail

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

supportHeartbeat

public boolean supportHeartbeat()

Description copied from interface: Protocol

check if the protocol supports heartbeat packet

Specified by:

supportHeartbeat in interface Protocol

returnChannelBeforeResponse

public boolean returnChannelBeforeResponse()

Description copied from interface: Protocol

连接被归还入池的时机

Specified by:

returnChannelBeforeResponse in interface Protocol

Returns:

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

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

isCoexistence

public boolean isCoexistence()

Description copied from interface: Protocol

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

Specified by:

isCoexistence in interface Protocol

Returns:

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