com.baidu.bigpipe.transport.pub

接口 PublishStrategy

所有超级接口:

TransportStrategy

所有已知实现类:

AbstractPublishStrategy, GroupPublishStrategy

public interface PublishStrategy
extends TransportStrategy

publish消息的抽象策略,用来控制如何接收和发送消息,比如单个消息发送，批量消息发送和打包发送

作者:

hexiufeng

方法概要

方法

限定符和类型	方法和说明
void	accqireToken() publish消息时由于内存queue容量是有限的,需要获取一个许可
void	accqireToken(int n) publish消息时由于内存queue容量是有限的,需要获取n个许可
void	fastFailed(SessionIdProvider sessionIdProvider) 发送任务时失败后，如何快速的失败
void	finishPub(ByteBuffer buf, SessionIdProvider sessionIdProvider) 一个发送任务被成功发送后需要处理的行为
int	getCurrentTaskCount() 在tcp的双工模式下，可以并发的发送任务和接收信息，并发会消耗资源，使用本方法获取可并发处理的任务量
WriteTask	getNextTask(LogIdGen idGen, long messageId, String sessionId, String topicName) 生成下一个需要发送的任务，每一个任务可能需要发送单个、一批或者一包消息
boolean	handlePubTimeout(SessionIdProvider sessionIdProvider) 监控当前是否有任务已经持续很久，可能超时
void	handleShutDown(SessionIdProvider sessionIdProvider) 当Session关闭时如何处理未发送的消息
void	releaseToken() 消息处理完后需要释放一个许可
void	releaseToken(int n) 消息处理完后需要释放n个许可
void	submitMessage(List<Message> msgList, InternalFutrue futrue) 提交要发送的批量消息
void	submitMessage(Message msg) 提交要发送的单个消息

从接口继承的方法 com.baidu.bigpipe.transport.TransportStrategy

applySocketConf, buildSimpleCommand, getProvider

方法详细资料

submitMessage

void submitMessage(Message msg)

提交要发送的单个消息

参数:

msg - 消息对象

submitMessage

void submitMessage(List<Message> msgList,
                 InternalFutrue futrue)

提交要发送的批量消息

参数:

msgList - 消息list

futrue - 内部futrue，用于触发任务结束事件

getNextTask

WriteTask getNextTask(LogIdGen idGen,
                    long messageId,
                    String sessionId,
                    String topicName)

生成下一个需要发送的任务，每一个任务可能需要发送单个、一批或者一包消息

参数:

idGen - id生成器

messageId - 消息id

sessionId - sessionid

topicName - bigpipe topic name

返回:

任务

handleShutDown

void handleShutDown(SessionIdProvider sessionIdProvider)

当Session关闭时如何处理未发送的消息

参数:

sessionIdProvider - sessionIdProvider

finishPub

void finishPub(ByteBuffer buf,
             SessionIdProvider sessionIdProvider)

一个发送任务被成功发送后需要处理的行为

参数:

buf - 内容

sessionIdProvider - SessionIdProvider

fastFailed

void fastFailed(SessionIdProvider sessionIdProvider)

发送任务时失败后，如何快速的失败

参数:

sessionIdProvider - SessionIdProvider

accqireToken

void accqireToken()
                  throws InterruptedException

publish消息时由于内存queue容量是有限的,需要获取一个许可

抛出:

InterruptedException - 线程被打断

releaseToken

void releaseToken()

消息处理完后需要释放一个许可

accqireToken

void accqireToken(int n)
                  throws InterruptedException

publish消息时由于内存queue容量是有限的,需要获取n个许可

参数:

n - 获取token的数量

抛出:

InterruptedException - 线程被打断异常

releaseToken

void releaseToken(int n)

消息处理完后需要释放n个许可

参数:

n - 许可的数量

getCurrentTaskCount

int getCurrentTaskCount()

在tcp的双工模式下，可以并发的发送任务和接收信息，并发会消耗资源，使用本方法获取可并发处理的任务量

返回:

并发任务数量

handlePubTimeout

boolean handlePubTimeout(SessionIdProvider sessionIdProvider)

监控当前是否有任务已经持续很久，可能超时

参数:

sessionIdProvider - SessionIdProvider

返回:

if need to reconnect tcp