com.netflix.dyno.queues

Interface DynoQueue

All Known Implementing Classes:

RedisDynoQueue

public interface DynoQueue

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)
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()

Method Detail

getName

java.lang.String getName()

Returns:

Returns the name of the queue

getUnackTime

int getUnackTime()

Returns:

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

See Also:

ack(String)

push

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

Parameters:

messages - messages to be pushed onto the queue

Returns:

Returns the list of message ids

pop

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

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:

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

peek

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

Provides a peek into the queue without taking messages out.

Parameters:

messageCount - number of messages to be peeked.

Returns:

List of peeked messages.

See Also:

pop(int, int, TimeUnit)

ack

boolean ack(java.lang.String messageId)

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

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

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

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.

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

boolean remove(java.lang.String messageId)

Parameters:

messageId - Remove the message from the queue

Returns:

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

get

Message get(java.lang.String messageId)

Parameters:

messageId - message to be retrieved.

Returns:

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

size

long size()

Returns:

Size of the queue.

See Also:

shardSizes()

shardSizes

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

Returns:

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

See Also:

size()

clear

void clear()

Truncates the entire queue. Use with caution!