cn.xnatural.app

Class Devourer

java.lang.Object

cn.xnatural.app.Devourer

public class Devourer
extends Object

对列执行器 按顺序执行添加的Runnable 当需要按顺序控制任务 一个一个, 两个两个... 的执行任务时

Field Summary

Fields

Modifier and Type	Field and Description
protected BiConsumer<Throwable,Devourer>	errorHandler 错误处理函数
protected Executor	exec 线程池
protected Integer	failMaxKeep 对列中失败的最大保留个数, 如果 大于0 执行失败, 暂时保留, 直至 排对的个数大于此值 否则 失败丢弃 默认: 执行失败,丢弃
protected String	key 队列标识
protected LatchLock	lock 流量限制锁
protected static org.slf4j.Logger	log
protected Predicate<Devourer>	pauseCondition 暂停执行条件
protected boolean	useLast 使用最后入队想任务/任务最后有效 useLast(boolean)
protected Deque<Runnable>	waiting 任务执行对列

Constructor Summary

Constructors

Constructor and Description
Devourer()
Devourer(String key) 创建对列
Devourer(String key, Executor exec) 创建对列

Method Summary

Modifier and Type	Method and Description
Devourer	errorHandle(BiConsumer<Throwable,Devourer> handler) 错误处理
Devourer	failMaxKeep(Integer maxKeep) 执行失败时, 保留最大个数 NOTE: 失败的任务会不断的重试执行, 直到成功或者对列中的个数大于此值被删除 典型应用: 数据上报场景
int	getWaitingCount() 排对个数
boolean	isSuspended() 是否是暂停状态
Devourer	offer(Runnable fn) 任务入对列
int	parallel() 正在执行的任务数
Devourer	parallel(int parallel) 设置并发数
Devourer	resume() 手动恢复执行
void	shutdown() 关闭
Devourer	suspend(Duration duration) 暂停一段时间 NOTE 继续执行条件: 必须有新的任务入对, 或者手动调用 resume()
Devourer	suspend(Predicate<Devourer> pauseCondition) 设置暂停条件 使用 resume() 恢复
String	toString()
protected void	trigger() 不断的从 waiting 对列中取出执行
Devourer	useLast(boolean useLast) 是否只使用队列最后一个, 清除队列前面的任务 适合: 入队的频率比出队高, 前面的任务可有可无

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

log

protected static final org.slf4j.Logger log

exec

protected final Executor exec

线程池

key

protected final String key

队列标识

failMaxKeep

protected Integer failMaxKeep

对列中失败的最大保留个数, 如果 大于0 执行失败, 暂时保留, 直至 排对的个数大于此值 否则 失败丢弃 默认: 执行失败,丢弃

lock

protected final LatchLock lock

流量限制锁

waiting

protected final Deque<Runnable> waiting

任务执行对列

errorHandler

protected BiConsumer<Throwable,Devourer> errorHandler

错误处理函数

pauseCondition

protected Predicate<Devourer> pauseCondition

暂停执行条件

useLast

protected boolean useLast

使用最后入队想任务/任务最后有效 useLast(boolean)

Constructor Detail

Devourer

public Devourer(String key,
                Executor exec)

创建对列

Parameters:

key - 对列标识

exec - 线程池

Devourer

public Devourer(String key)

创建对列

Parameters:

key - 对列标识

Devourer

public Devourer()

Method Detail

offer

public Devourer offer(Runnable fn)

任务入对列

Parameters:

fn - 任务函数

Returns:

Devourer

trigger

protected void trigger()

不断的从 waiting 对列中取出执行

parallel

public Devourer parallel(int parallel)

设置并发数

Parameters:

parallel - >=1

Returns:

Devourer

getWaitingCount

public int getWaitingCount()

排对个数

Returns:

排对个数

errorHandle

public Devourer errorHandle(BiConsumer<Throwable,Devourer> handler)

错误处理

Parameters:

handler - 错误处理器

Returns:

Devourer

failMaxKeep

public Devourer failMaxKeep(Integer maxKeep)

执行失败时, 保留最大个数 NOTE: 失败的任务会不断的重试执行, 直到成功或者对列中的个数大于此值被删除 典型应用: 数据上报场景

Returns:

Devourer

suspend

public Devourer suspend(Duration duration)

暂停一段时间 NOTE 继续执行条件: 必须有新的任务入对, 或者手动调用 resume()

Parameters:

duration - 一段时间

Returns:

Devourer

suspend

public Devourer suspend(Predicate<Devourer> pauseCondition)

设置暂停条件 使用 resume() 恢复

Parameters:

pauseCondition - 暂停条件

Returns:

Devourer

resume

public Devourer resume()

手动恢复执行

Returns:

Devourer

useLast

public Devourer useLast(boolean useLast)

是否只使用队列最后一个, 清除队列前面的任务 适合: 入队的频率比出队高, 前面的任务可有可无

isSuspended

public boolean isSuspended()

是否是暂停状态

Returns:

true: 暂停中

parallel

public int parallel()

正在执行的任务数

shutdown

public void shutdown()

关闭

toString

public String toString()

Overrides:

toString in class Object