com.netflix.dyno.queues.redis

Class RedisDynoQueue

java.lang.Object

com.netflix.dyno.queues.redis.RedisDynoQueue

All Implemented Interfaces:

DynoQueue

public class RedisDynoQueue
extends java.lang.Object
implements DynoQueue

Constructor Summary

Constructors

Constructor and Description
RedisDynoQueue(java.lang.String redisKeyPrefix, java.lang.String queueName, java.util.Set<java.lang.String> allShards, java.lang.String shardName, java.util.concurrent.ExecutorService dynoCallExecutor)

Method Summary

Modifier and Type	Method and Description
boolean	ack(java.lang.String messageId) Provides an acknowledgement for the message.
void	clear() Truncates the entire queue.
Message	get(java.lang.String messageId)
java.lang.String	getName()
int	getUnackTime()
java.util.List<Message>	peek(int messageCount) Provides a peek into the queue without taking messages out.
java.util.List<Message>	pop(int messageCount, int wait, java.util.concurrent.TimeUnit unit)
void	processUnacks()
java.util.List<java.lang.String>	push(java.util.List<Message> messages)
boolean	remove(java.lang.String messageId)
boolean	setUnackTimeout(java.lang.String messageId, long timeout) Sets the unack timeout on the message (changes the default timeout to the new value).
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Long>>	shardSizes()
long	size()
RedisDynoQueue	withNonQuorumConn(redis.clients.jedis.JedisCommands nonQuorumConn)
RedisDynoQueue	withQuorumConn(redis.clients.jedis.JedisCommands quorumConn)
RedisDynoQueue	withUnackSchedulerTime(int unackScheduleInMS)
RedisDynoQueue	withUnackTime(int unackTime)

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisDynoQueue

public RedisDynoQueue(java.lang.String redisKeyPrefix,
                      java.lang.String queueName,
                      java.util.Set<java.lang.String> allShards,
                      java.lang.String shardName,
                      java.util.concurrent.ExecutorService dynoCallExecutor)

Method Detail

withQuorumConn

public RedisDynoQueue withQuorumConn(redis.clients.jedis.JedisCommands quorumConn)

withNonQuorumConn

public RedisDynoQueue withNonQuorumConn(redis.clients.jedis.JedisCommands nonQuorumConn)

withUnackTime

public RedisDynoQueue withUnackTime(int unackTime)

withUnackSchedulerTime

public RedisDynoQueue withUnackSchedulerTime(int unackScheduleInMS)

getName

public java.lang.String getName()

Specified by:

getName in interface DynoQueue

Returns:

Returns the name of the queue

getUnackTime

public int getUnackTime()

Specified by:

getUnackTime in interface DynoQueue

Returns:

Time in milliseconds before the messages that are popped and not acknowledge are pushed back into the queue.

See Also:

DynoQueue.ack(String)

push

public java.util.List<java.lang.String> push(java.util.List<Message> messages)

Specified by:

push in interface DynoQueue

Parameters:

messages - messages to be pushed onto the queue

Returns:

Returns the list of message ids

peek

public java.util.List<Message> peek(int messageCount)

Description copied from interface: DynoQueue

Provides a peek into the queue without taking messages out.

Specified by:

peek in interface DynoQueue

Parameters:

messageCount - number of messages to be peeked.

Returns:

List of peeked messages.

See Also:

DynoQueue.pop(int, int, TimeUnit)

pop

public java.util.List<Message> pop(int messageCount,
                                   int wait,
                                   java.util.concurrent.TimeUnit unit)

Specified by:

pop in interface DynoQueue

Parameters:

messageCount - number of messages to be popped out of the queue.

wait - Amount of time to wait if there are no messages in queue

unit - Time unit for the wait period

Returns:

messages. Can be less than the messageCount if there are fewer messages available than the message count. If the popped messages are not acknowledge in a timely manner, they are pushed back into the queue.

See Also:

DynoQueue.peek(int), DynoQueue.ack(String), DynoQueue.getUnackTime()

ack

public boolean ack(java.lang.String messageId)

Description copied from interface: DynoQueue

Provides an acknowledgement for the message. Once ack'ed the message is removed from the queue forever.

Specified by:

ack in interface DynoQueue

Parameters:

messageId - ID of the message to be acknowledged

Returns:

true if the message was found pending acknowledgement and is now ack'ed. false if the message id is invalid or message is no longer present in the queue.

setUnackTimeout

public boolean setUnackTimeout(java.lang.String messageId,
                               long timeout)

Description copied from interface: DynoQueue

Sets the unack timeout on the message (changes the default timeout to the new value). Useful when extended lease is required for a message by consumer before sending ack.

Specified by:

setUnackTimeout in interface DynoQueue

Parameters:

messageId - ID of the message to be acknowledged

timeout - time in milliseconds for which the message will remain in un-ack state. If no ack is received after the timeout period has expired, the message is put back into the queue

Returns:

true if the message was found pending acknowledgement and is now ack'ed. false if the message id is invalid or message is no longer present in the queue.

remove

public boolean remove(java.lang.String messageId)

Specified by:

remove in interface DynoQueue

Parameters:

messageId - Remove the message from the queue

Returns:

true if the message id was found and removed. False otherwise.

get

public Message get(java.lang.String messageId)

Specified by:

get in interface DynoQueue

Parameters:

messageId - message to be retrieved.

Returns:

Retrieves the message stored in the queue by the messageId. Null if not found.

size

public long size()

Specified by:

size in interface DynoQueue

Returns:

Size of the queue.

See Also:

DynoQueue.shardSizes()

shardSizes

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Long>> shardSizes()

Specified by:

shardSizes in interface DynoQueue

Returns:

Map of shard name to the # of messages in the shard.

See Also:

DynoQueue.size()

clear

public void clear()

Description copied from interface: DynoQueue

Truncates the entire queue. Use with caution!

Specified by:

clear in interface DynoQueue

processUnacks

public void processUnacks()