Package cn.sliew.carp.framework.queue.kekio.redis

Class AbstractRedisQueue<CLIENT extends redis.clients.jedis.commands.JedisCommands>

java.lang.Object

cn.sliew.carp.framework.queue.kekio.AbstractLifecycle

cn.sliew.carp.framework.queue.kekio.AbstractQueue

cn.sliew.carp.framework.queue.kekio.redis.AbstractRedisQueue<CLIENT>

All Implemented Interfaces:

MonitorableQueue, Queue, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

Direct Known Subclasses:

RedisQueue

public abstract class AbstractRedisQueue<CLIENT extends redis.clients.jedis.commands.JedisCommands>
extends AbstractQueue
implements MonitorableQueue

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractRedisQueue.Fingerprint

Nested classes/interfaces inherited from interface cn.sliew.carp.framework.queue.kekio.metrics.MonitorableQueue

MonitorableQueue.QueueState

Nested classes/interfaces inherited from interface cn.sliew.carp.framework.queue.kekio.Queue

Queue.DeadMessageCallback, Queue.QueueCallback

Field Summary

Fields

Modifier and Type	Field	Description
protected final Integer	lockTtlSeconds
protected final com.fasterxml.jackson.databind.ObjectMapper	mapper
protected static final String	READ_MESSAGE_SRC
protected static final String	READ_MESSAGE_WITH_LOCK_SRC

Fields inherited from class cn.sliew.carp.framework.queue.kekio.AbstractQueue

ackTimeout, canPollMany, deadMessageHandlers, publisher

Fields inherited from interface cn.sliew.carp.framework.queue.kekio.Queue

MAX_RETRIES

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRedisQueue(com.fasterxml.jackson.databind.ObjectMapper mapper, String name, QueueExecutor queueExecutor, Collection<MessageHandler> handlers, List<Queue.DeadMessageCallback> deadMessageHandlers, EventPublisher publisher, io.micrometer.core.instrument.MeterRegistry meterRegistry, Boolean fillExecutorEachCycle, Duration requeueDelay, Duration requeueMaxJitter, Boolean canPollMany, TemporalAmount ackTimeout, Integer lockTtlSeconds)

Method Summary

Modifier and Type	Method	Description
protected boolean	anyZismember(redis.clients.jedis.commands.JedisCommands commands, String key, Set<String> members)
abstract void	cacheScript()
Boolean	canPollMany()	Denotes a queue implementation capable of processing multiple messages per poll.
protected AbstractRedisQueue.Fingerprint	fingerprint(Message message)
protected String	firstFingerprint(String key, AbstractRedisQueue.Fingerprint fingerprint)
TemporalAmount	getAckTimeout()	The expired time after which un-acknowledged messages will be retried.
protected abstract String	getAttemptsKey()
List<Queue.DeadMessageCallback>	getDeadMessageHandlers()	A handler for messages that have failed to acknowledge delivery more than [Queue.ackTimeout] times.
protected abstract String	getLocksKey()
protected abstract String	getMessagesKey()
EventPublisher	getPublisher()
protected abstract String	getQueueKey()
protected abstract String	getReadMessageWithLockScriptSha()
protected abstract String	getUnackedKey()
protected void	handleDeadMessage(Message message)
protected String	hashV1(Message message)	Deprecated. Hashes the attributes property, which is mutable
protected String	hashV2(Message message)
protected int	hgetInt(String key, String field)
protected int	hgetInt(String key, String field, int defaultValue)
protected abstract <E extends Throwable> List<Object>	multi(cn.sliew.milky.common.function.CheckedConsumer<redis.clients.jedis.Transaction,E> block)
protected double	score()
protected double	score(TemporalAmount delay)
protected abstract void	setReadMessageWithLockScriptSha(String sha)
protected void	withJedis(Consumer<CLIENT> consumer)
protected abstract <T> T	withJedis(Function<CLIENT,T> function)
protected boolean	zismember(redis.clients.jedis.commands.JedisCommands commands, String key, String member)

Methods inherited from class cn.sliew.carp.framework.queue.kekio.AbstractQueue

doStart, doStop, getName

Methods inherited from class cn.sliew.carp.framework.queue.kekio.AbstractLifecycle

isRunning, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.Lifecycle

isRunning, start, stop

Methods inherited from interface cn.sliew.carp.framework.queue.kekio.metrics.MonitorableQueue

containsMessage, fire, readState

Methods inherited from interface cn.sliew.carp.framework.queue.kekio.Queue

clear, getName, poll, poll, push, push, retry

Methods inherited from interface org.springframework.context.SmartLifecycle

getPhase, isAutoStartup, stop

Field Details

lockTtlSeconds

protected final Integer lockTtlSeconds

mapper

protected final com.fasterxml.jackson.databind.ObjectMapper mapper

READ_MESSAGE_SRC

protected static final String READ_MESSAGE_SRC

See Also:

• Constant Field Values

READ_MESSAGE_WITH_LOCK_SRC

protected static final String READ_MESSAGE_WITH_LOCK_SRC

See Also:

• Constant Field Values

Constructor Details

AbstractRedisQueue

protected AbstractRedisQueue(com.fasterxml.jackson.databind.ObjectMapper mapper,
 String name,
 QueueExecutor queueExecutor,
 Collection<MessageHandler> handlers,
 List<Queue.DeadMessageCallback> deadMessageHandlers,
 EventPublisher publisher,
 io.micrometer.core.instrument.MeterRegistry meterRegistry,
 Boolean fillExecutorEachCycle,
 Duration requeueDelay,
 Duration requeueMaxJitter,
 Boolean canPollMany,
 TemporalAmount ackTimeout,
 Integer lockTtlSeconds)

Method Details

getQueueKey

protected abstract String getQueueKey()

getUnackedKey

protected abstract String getUnackedKey()

getMessagesKey

protected abstract String getMessagesKey()

getLocksKey

protected abstract String getLocksKey()

getAttemptsKey

protected abstract String getAttemptsKey()

cacheScript

public abstract void cacheScript()

getReadMessageWithLockScriptSha

protected abstract String getReadMessageWithLockScriptSha()

setReadMessageWithLockScriptSha

protected abstract void setReadMessageWithLockScriptSha(String sha)

withJedis

protected abstract <T> T withJedis(Function<CLIENT,T> function)

withJedis

protected void withJedis(Consumer<CLIENT> consumer)

getAckTimeout

public TemporalAmount getAckTimeout()

Description copied from interface: Queue

The expired time after which un-acknowledged messages will be retried.

Specified by:

getAckTimeout in interface Queue

getDeadMessageHandlers

public List<Queue.DeadMessageCallback> getDeadMessageHandlers()

Description copied from interface: Queue

A handler for messages that have failed to acknowledge delivery more than [Queue.ackTimeout] times.

Specified by:

getDeadMessageHandlers in interface Queue

canPollMany

public Boolean canPollMany()

Description copied from interface: Queue

Denotes a queue implementation capable of processing multiple messages per poll.

Specified by:

canPollMany in interface Queue

getPublisher

public EventPublisher getPublisher()

Specified by:

getPublisher in interface MonitorableQueue

handleDeadMessage

protected void handleDeadMessage(Message message)

score

protected double score()

Returns:

current time (plus optional delay) converted to a score for a Redis sorted set.

score

protected double score(TemporalAmount delay)

multi

protected abstract <E extends Throwable>
List<Object> multi(cn.sliew.milky.common.function.CheckedConsumer<redis.clients.jedis.Transaction,E> block)

hgetInt

protected int hgetInt(String key,
 String field)

hgetInt

protected int hgetInt(String key,
 String field,
 int defaultValue)

zismember

protected boolean zismember(redis.clients.jedis.commands.JedisCommands commands,
 String key,
 String member)

anyZismember

protected boolean anyZismember(redis.clients.jedis.commands.JedisCommands commands,
 String key,
 Set<String> members)

firstFingerprint

protected String firstFingerprint(String key,
 AbstractRedisQueue.Fingerprint fingerprint)

hashV1

@Deprecated
protected String hashV1(Message message)

Deprecated.

Hashes the attributes property, which is mutable

hashV2

protected String hashV2(Message message)

fingerprint

protected AbstractRedisQueue.Fingerprint fingerprint(Message message)