Package com.github.ddth.queue.impl

Class RedisQueue<ID,DATA>

java.lang.Object

com.github.ddth.queue.impl.AbstractQueue<ID,DATA>

com.github.ddth.queue.impl.AbstractEphemeralSupportQueue<ID,DATA>

com.github.ddth.queue.impl.BaseRedisQueue<ID,DATA>

com.github.ddth.queue.impl.RedisQueue<ID,DATA>

All Implemented Interfaces:

IQueue<ID,DATA>, AutoCloseable

Direct Known Subclasses:

BaseUniversalRedisQueue

public abstract class RedisQueue<ID,DATA>
extends BaseRedisQueue<ID,DATA>

Redis implementation of IQueue.

Implementation:

• A hash to store message, format {queue_id => message}. See BaseRedisQueue.setRedisHashName(String).
• A list to act as a queue of message's queue_id. See BaseRedisQueue.setRedisListName(String).
• A sorted set to act as ephemeral storage of message's queue_id, score is message's timestamp. See BaseRedisQueue.setRedisSortedSetName(String).

Features:

• Queue-size support: yes
• Ephemeral storage support: yes
• Ephemeral-size support: yes

Since:

0.3.1

Author:

Thanh Ba Nguyen

Nested Class Summary

Nested classes/interfaces inherited from class com.github.ddth.queue.impl.AbstractQueue

AbstractQueue.PutToQueueCase

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_HOST_AND_PORT

Fields inherited from class com.github.ddth.queue.impl.BaseRedisQueue

DEFAULT_HASH_NAME, DEFAULT_LIST_NAME, DEFAULT_PASSWORD, DEFAULT_SORTED_SET_NAME, myOwnRedis

Fields inherited from interface com.github.ddth.queue.IQueue

SIZE_NOT_SUPPORTED

Constructor Summary

Constructors

Constructor	Description
RedisQueue()

Method Summary

Modifier and Type	Method	Description
protected com.github.ddth.commons.redis.JedisConnector	buildJedisConnector()	Build a JedisConnector instance for my own use.
protected void	closeJedisCommands(redis.clients.jedis.BinaryJedisCommands jedisCommands)	Close the unused BinaryJedisCommands.
protected redis.clients.jedis.BinaryJedisCommands	getBinaryJedisCommands()	Get BinaryJedisCommands instance.
String	getRedisHostAndPort()	Redis host and port scheme (format host:port).
protected boolean	remove(IQueueMessage<ID,DATA> msg)	Remove a message completely.
RedisQueue<ID,DATA>	setRedisHostAndPort(String redisHostAndPort)	Redis host and port scheme (format host:port).
protected boolean	storeNew(IQueueMessage<ID,DATA> msg)	Store a new message.
protected boolean	storeOld(IQueueMessage<ID,DATA> msg)	Re-store an old message (called by AbstractQueue.requeue(IQueueMessage) or AbstractQueue.requeueSilent(IQueueMessage).
IQueueMessage<ID,DATA>	take()	Take a message out of queue.

Methods inherited from class com.github.ddth.queue.impl.BaseRedisQueue

destroy, doPutToQueue, ephemeralSize, finish, getJedisConnector, getOrphanMessages, getRedisHashName, getRedisHashNameAsBytes, getRedisListName, getRedisListNameAsBytes, getRedisPassword, getRedisSortedSetName, getRedisSortedSetNameAsBytes, getScriptTake, getScriptTakeAsBytes, init, queueSize, setJedisConnector, setJedisConnector, setRedisHashName, setRedisListName, setRedisPassword, setRedisSortedSetName, setScriptTake

Methods inherited from class com.github.ddth.queue.impl.AbstractEphemeralSupportQueue

getEphemeralDisabled, getEphemeralMaxSize, isEphemeralDisabled, setEphemeralDisabled, setEphemeralMaxSize

Methods inherited from class com.github.ddth.queue.impl.AbstractQueue

close, createMessage, createMessage, createMessage, deserialize, deserialize, getMessageFactory, getQueueName, getSerDeser, queue, requeue, requeueSilent, serialize, setMessageFactory, setQueueName, setSerDeser

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOST_AND_PORT

public static final String DEFAULT_HOST_AND_PORT

See Also:

Constant Field Values

Constructor Detail

RedisQueue

public RedisQueue()

Method Detail

getRedisHostAndPort

public String getRedisHostAndPort()

Redis host and port scheme (format host:port).

Returns:

setRedisHostAndPort

public RedisQueue<ID,DATA> setRedisHostAndPort(String redisHostAndPort)

Redis host and port scheme (format host:port).

Parameters:

redisHostAndPort -

Returns:

buildJedisConnector

protected com.github.ddth.commons.redis.JedisConnector buildJedisConnector()

Build a JedisConnector instance for my own use.

Specified by:

buildJedisConnector in class BaseRedisQueue<ID,DATA>

Returns:

getBinaryJedisCommands

protected redis.clients.jedis.BinaryJedisCommands getBinaryJedisCommands()

Get BinaryJedisCommands instance.

Specified by:

getBinaryJedisCommands in class BaseRedisQueue<ID,DATA>

Returns:

closeJedisCommands

protected void closeJedisCommands(redis.clients.jedis.BinaryJedisCommands jedisCommands)

Close the unused BinaryJedisCommands.

Specified by:

closeJedisCommands in class BaseRedisQueue<ID,DATA>

remove

protected boolean remove(IQueueMessage<ID,DATA> msg)

Remove a message completely.

Implementation note:

• Message should no longer exist after method call regardless of return value (true or false)
• In case of error, throws QueueException

Specified by:

remove in class BaseRedisQueue<ID,DATA>

Returns:

true if the message has been removed, false means the message does not exist for completely removal

storeNew

protected boolean storeNew(IQueueMessage<ID,DATA> msg)

Store a new message.

Implementation note:

• Message's ID must be successfully pushed into the "queue-list" so that the method call is considered successful. If message's id has not pushed to the "queue-list", this method must return false.
• Caller can retry if method returns false. Implementation's responsibility to ensure message is not duplicated in storage.
• In case of error, throws QueueException

Specified by:

storeNew in class BaseRedisQueue<ID,DATA>

Returns:

storeOld

protected boolean storeOld(IQueueMessage<ID,DATA> msg)

Re-store an old message (called by AbstractQueue.requeue(IQueueMessage) or AbstractQueue.requeueSilent(IQueueMessage).

Implementation note:

• Message's ID must be successfully pushed into the "queue-list" so that the method call is considered successful. If message's id has not pushed to the "queue-list", this method must return false.
• Caller can retry if method returns false. Implementation's responsibility to ensure message is not duplicated in storage.
• In case of error, throws QueueException

Specified by:

storeOld in class BaseRedisQueue<ID,DATA>

Returns:

take

public IQueueMessage<ID,DATA> take()
                                  throws QueueException.EphemeralIsFull

Take a message out of queue.

Implementation flow:

• Read message from head of queue storage.
• Write message to ephemeral storage.
• Remove message from queue storage.

Note: ephemeral storage implementation is optional, depends on implementation.

Returns:

Throws:

QueueException.EphemeralIsFull - if the ephemeral storage is full