RedisQueue (ddth-queue-core 0.4.2 API)

java.lang.Object
- com.github.ddth.queue.impl.RedisQueue

All Implemented Interfaces:

IQueue, Closeable, AutoCloseable

Direct Known Subclasses:

BaseUniversalRedisQueue
```
public abstract class RedisQueue
extends Object
implements IQueue, Closeable, AutoCloseable
```
Redis implementation of IQueue.
Implementation:
- A hash to store message, format {queue_id => message}. See setRedisHashName(String).
- A list to act as a queue of message's queue_id. See setRedisListName(String).
- A sorted set to act as ephemeral storage of message's queue_id, score is message's timestamp. See setRedisSortedSetName(String).
Since:

0.3.1

Author:

Thanh Ba Nguyen

Constructor Summary

Constructors
Constructor and Description

RedisQueue()

Constructors
Constructor and Description
`RedisQueue()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`protected abstract IQueueMessage`	`deserialize(byte[] msgData)` Deserilizes a queue message.
`void`	`destroy()` Destroy method.
`int`	`ephemeralSize()` Gets ephemeral-storage's number of items.
`void`	`finish(IQueueMessage msg)` Called when finish processing the message to cleanup ephemeral storage.
`boolean`	`getEphemeralDisabled()` Is ephemeral storage disabled?
`protected redis.clients.jedis.JedisPool`	`getJedisPool()`
`Collection<IQueueMessage>`	`getOrphanMessages(long thresholdTimestampMs)` Gets all orphan messages (messages that were left in ephemeral storage for a long time).
`String`	`getRedisHashName()`
`String`	`getRedisHostAndPort()` Redis' host and port scheme (format `host:port`).
`String`	`getRedisListName()`
`String`	`getRedisSortedSetName()`
`RedisQueue`	`init()` Init method.
`boolean`	`isEphemeralDisabled()` Is ephemeral storage disabled?
`boolean`	`moveFromEphemeralToQueueStorage(IQueueMessage msg)` Moves a message from ephemeral back to queue storage.
`boolean`	`queue(IQueueMessage _msg)` Queues a message.
`int`	`queueSize()` Gets queue's number of items.
`protected boolean`	`remove(IQueueMessage msg)` Removes a message completely.
`boolean`	`requeue(IQueueMessage _msg)` Re-queues a message.
`boolean`	`requeueSilent(IQueueMessage msg)` Silently re-queues a message.
`protected abstract byte[]`	`serialize(IQueueMessage msg)` Serializes a queue message to store in Redis.
`RedisQueue`	`setEphemeralDisabled(boolean ephemeralDisabled)` Disables/Enables ephemeral storage.
`RedisQueue`	`setJedisPool(redis.clients.jedis.JedisPool jedisPool)`
`RedisQueue`	`setRedisHashName(String redisHashName)`
`RedisQueue`	`setRedisHostAndPort(String redisHostAndPort)` Sets Redis' host and port scheme (format `host:port`).
`RedisQueue`	`setRedisListName(String redisListName)`
`RedisQueue`	`setRedisSortedSetName(String redisSortedSetName)`
`protected boolean`	`storeNew(IQueueMessage msg)` Stores a new message.
`protected boolean`	`storeOld(IQueueMessage msg)` Re-stores an old message (called by `requeue(IQueueMessage)` or `requeueSilent(IQueueMessage)`.
`IQueueMessage`	`take()` Takes a message out of queue.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RedisQueue
```
public RedisQueue()
```
- Method Detail
  - getEphemeralDisabled
```
public boolean getEphemeralDisabled()
```
    Is ephemeral storage disabled?
    
    Returns:
    
    Since:
    
    0.4.0
  - isEphemeralDisabled
```
public boolean isEphemeralDisabled()
```
    Is ephemeral storage disabled?
    
    Returns:
    
    Since:
    
    0.4.0
  - setEphemeralDisabled
```
public RedisQueue setEphemeralDisabled(boolean ephemeralDisabled)
```
    Disables/Enables ephemeral storage.
    
    Parameters:
    
    ephemeralDisabled - true to disable ephemeral storage, false otherwise.
    
    Returns:
    
    Since:
    
    0.4.0
  - getRedisHostAndPort
```
public String getRedisHostAndPort()
```
    Redis' host and port scheme (format host:port).
    
    Returns:
  - setRedisHostAndPort
```
public RedisQueue setRedisHostAndPort(String redisHostAndPort)
```
    Sets Redis' host and port scheme (format host:port).
    
    Parameters:
    
    redisHostAndPort -
    
    Returns:
  - getRedisHashName
```
public String getRedisHashName()
```
  - setRedisHashName
```
public RedisQueue setRedisHashName(String redisHashName)
```
  - getRedisListName
```
public String getRedisListName()
```
  - setRedisListName
```
public RedisQueue setRedisListName(String redisListName)
```
  - getRedisSortedSetName
```
public String getRedisSortedSetName()
```
  - setRedisSortedSetName
```
public RedisQueue setRedisSortedSetName(String redisSortedSetName)
```
  - getJedisPool
```
protected redis.clients.jedis.JedisPool getJedisPool()
```
  - setJedisPool
```
public RedisQueue setJedisPool(redis.clients.jedis.JedisPool jedisPool)
```
  - init
```
public RedisQueue init()
```
    Init method.
    
    Returns:
  - destroy
```
public void destroy()
```
    Destroy method.
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Since:
    
    0.4.0
  - serialize
```
protected abstract byte[] serialize(IQueueMessage msg)
```
    Serializes a queue message to store in Redis.
    
    Parameters:
    
    msg -
    
    Returns:
  - deserialize
```
protected abstract IQueueMessage deserialize(byte[] msgData)
```
    Deserilizes a queue message.
    
    Parameters:
    
    msgData -
    
    Returns:
  - remove
```
protected boolean remove(IQueueMessage msg)
```
    Removes a message completely.
    
    Parameters:
    
    msg -
    
    Returns:
  - storeNew
```
protected boolean storeNew(IQueueMessage msg)
```
    Stores a new message.
    
    Parameters:
    
    msg -
    
    Returns:
  - storeOld
```
protected boolean storeOld(IQueueMessage msg)
```
    Re-stores an old message (called by requeue(IQueueMessage) or requeueSilent(IQueueMessage).
    
    Parameters:
    
    msg -
    
    Returns:
  - queue
```
public boolean queue(IQueueMessage _msg)
```
    Queues a message.
    Implementation flow:
    - Put message to tail of queue storage.
    Specified by:
    
    queue in interface IQueue
    
    Returns:
  - requeue
```
public boolean requeue(IQueueMessage _msg)
```
    Re-queues a message.
    Implementation flow:
    - Put message to tail of queue storage; and increase message's re-queue count & update message's queue timestamp.
    - Remove message from ephemeral storage.
    Note: ephemeral storage implementation is optional, depends on implementation.
    Specified by:
    
    requeue in interface IQueue
    
    Returns:
  - requeueSilent
```
public boolean requeueSilent(IQueueMessage msg)
```
    Silently re-queues a message.
    Implementation flow:
    - Put message to tail of queue storage; do NOT increase message's re-queue count and do NOT update message's queue timestamp.
    - Remove message from ephemeral storage.
    Note: ephemeral storage implementation is optional, depends on implementation.
    Specified by:
    
    requeueSilent in interface IQueue
    
    Returns:
  - finish
```
public void finish(IQueueMessage msg)
```
    Called when finish processing the message to cleanup ephemeral storage.
    Implementation flow:
    - Remove message from ephemeral storage.
    Note: ephemeral storage implementation is optional, depends on implementation.
    Specified by:
    
    finish in interface IQueue
  - take
```
public IQueueMessage take()
```
    Takes 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.
    Specified by:
    
    take in interface IQueue
    
    Returns:
  - getOrphanMessages
```
public Collection<IQueueMessage> getOrphanMessages(long thresholdTimestampMs)
```
    Gets all orphan messages (messages that were left in ephemeral storage for a long time).
    
    Specified by:
    
    getOrphanMessages in interface IQueue
    
    Parameters:
    
    thresholdTimestampMs -
    
    Returns:
  - moveFromEphemeralToQueueStorage
```
public boolean moveFromEphemeralToQueueStorage(IQueueMessage msg)
```
    Moves a message from ephemeral back to queue storage. Useful when dealing with orphan messages.
    Implementation flow:
    - Read message from the ephemeral storage.
    - Put the message back to queue.
    - Remove the message from the ephemeral storage.
    Specified by:
    
    moveFromEphemeralToQueueStorage in interface IQueue
    
    Returns:
    
    true if a move has been made, false otherwise (e.g. the message didn't exist in ephemeral storage)
  - queueSize
```
public int queueSize()
```
    Gets queue's number of items.
    
    Specified by:
    
    queueSize in interface IQueue
    
    Returns:
  - ephemeralSize
```
public int ephemeralSize()
```
    Gets ephemeral-storage's number of items.
    Note: ephemeral storage implementation is optional, depends on implementation.
    
    Specified by:
    
    ephemeralSize in interface IQueue
    
    Returns:

Class RedisQueue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RedisQueue

Method Detail

getEphemeralDisabled

isEphemeralDisabled

setEphemeralDisabled

getRedisHostAndPort

setRedisHostAndPort

getRedisHashName

setRedisHashName

getRedisListName

setRedisListName

getRedisSortedSetName

setRedisSortedSetName

getJedisPool

setJedisPool

init

destroy

close

serialize

deserialize

remove

storeNew

storeOld

queue

requeue

requeueSilent

finish

take

getOrphanMessages

moveFromEphemeralToQueueStorage

queueSize

ephemeralSize