Package com.github.ddth.queue

Interface IQueue<ID,DATA>

All Known Implementing Classes:

AbstractEphemeralSupportQueue, AbstractInmemEphemeralQueue, AbstractLessLockingUniversalJdbcQueue, AbstractLessLockingUniversalJdbcQueue, AbstractLessLockingUniversalSingleStorageJdbcQueue, AbstractLessLockingUniversalSingleStorageJdbcQueue, AbstractQueue, ActiveMqQueue, BaseLessLockingUniversalJdbcQueue, BaseLessLockingUniversalSingleStorageJdbcQueue, BaseRedisQueue, BaseUniversalActiveMqQueue, BaseUniversalDisruptorQueue, BaseUniversalInmemQueue, BaseUniversalJdbcQueue, BaseUniversalKafkaQueue, BaseUniversalMongodbQueue, BaseUniversalRabbitMqQueue, BaseUniversalRedisQueue, BaseUniversalRocksDbQueue, DisruptorQueue, InmemQueue, JdbcQueue, KafkaQueue, LessLockingUniversalMySQLQueue, LessLockingUniversalMySQLQueue, LessLockingUniversalPgSQLQueue, LessLockingUniversalPgSQLQueue, LessLockingUniversalSingleStorageMySQLQueue, LessLockingUniversalSingleStorageMySQLQueue, LessLockingUniversalSingleStoragePgSQLQueue, LessLockingUniversalSingleStoragePgSQLQueue, MongodbQueue, RabbitMqQueue, RedisQueue, RocksDbQueue, UniversalActiveMqQueue, UniversalActiveMqQueue, UniversalDisruptorQueue, UniversalDisruptorQueue, UniversalInmemQueue, UniversalInmemQueue, UniversalJdbcQueue, UniversalJdbcQueue, UniversalKafkaQueue, UniversalKafkaQueue, UniversalMongodbQueue, UniversalMongodbQueue, UniversalRabbitMqQueue, UniversalRabbitMqQueue, UniversalRedisQueue, UniversalRedisQueue, UniversalRocksDbQueue, UniversalRocksDbQueue, UniversalSingleStorageJdbcQueue, UniversalSingleStorageJdbcQueue

public interface IQueue<ID,DATA>

APIs to interact with queue.

Queue implementation flow:

1. Call take() to get a IQueueMessage from queue.
2. Do something with the message.
   1. If done with the message, call finish(IQueueMessage).
   2. Otherwise, call requeue(IQueueMessage) or requeueSilent(IQueueMessage) to requeue the message.

Since:

0.1.0

Author:

Thanh Ba Nguyen

Field Summary

Fields

Modifier and Type	Field	Description
static int	SIZE_NOT_SUPPORTED	Return this value to indicate that get-size functionality is not supported.

Method Summary

Modifier and Type	Method	Description
IQueueMessage<ID,DATA>	createMessage()	Create a new, empty queue message.
default IQueueMessage<ID,DATA>	createMessage(DATA content)	Create a new queue message with supplied content.
default IQueueMessage<ID,DATA>	createMessage(ID id, DATA content)	Create a new queue message with supplied id and content.
int	ephemeralSize()	Get number of items currently in ephemeral storage.
void	finish(IQueueMessage<ID,DATA> msg)	Called when finish processing the message to cleanup ephemeral storage.
Collection<IQueueMessage<ID,DATA>>	getOrphanMessages(long thresholdTimestampMs)	Get all orphan messages (messages that were left in ephemeral storage for a long time).
boolean	queue(IQueueMessage<ID,DATA> msg)	Queue a message.
int	queueSize()	Get number of items currently in queue storage.
boolean	requeue(IQueueMessage<ID,DATA> msg)	Re-queue a message.
boolean	requeueSilent(IQueueMessage<ID,DATA> msg)	Silently re-queue a message.
IQueueMessage<ID,DATA>	take()	Take a message out of queue.

Field Detail

SIZE_NOT_SUPPORTED

static final int SIZE_NOT_SUPPORTED

Return this value to indicate that get-size functionality is not supported.

Since:

0.7.1

See Also:

Constant Field Values

Method Detail

createMessage

IQueueMessage<ID,DATA> createMessage()

Create a new, empty queue message.

Returns:

Since:

0.6.0

createMessage

default IQueueMessage<ID,DATA> createMessage(DATA content)

Create a new queue message with supplied content.

Parameters:

content -

Returns:

Since:

0.6.0

createMessage

default IQueueMessage<ID,DATA> createMessage(ID id,
                                                   DATA content)

Create a new queue message with supplied id and content.

Parameters:

id -

content -

Returns:

Since:

0.6.0

queue

boolean queue(IQueueMessage<ID,DATA> msg)
       throws QueueException

Queue a message.

Implementation flow:

• Put message to tail of queue storage.

Parameters:

msg -

Returns:

Throws:

QueueException.QueueIsFull - if queue storage is full, can not take any more message

QueueException.CannotSerializeQueueMessage - if the supplied message can not be serialize

QueueException - other queue exceptions

requeue

boolean requeue(IQueueMessage<ID,DATA> msg)
         throws QueueException

Re-queue a message.

Implementation flow:

• Put message to the queue storage (head or tail position depends on the queue implementation); 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.

Parameters:

msg -

Returns:

Throws:

QueueException.QueueIsFull - if queue storage is full, can not take any more message

QueueException.CannotSerializeQueueMessage - if the supplied message can not be serialize

QueueException - other queue exceptions

requeueSilent

boolean requeueSilent(IQueueMessage<ID,DATA> msg)
               throws QueueException

Silently re-queue a message.

Implementation flow:

• Put message to the queue storage (head or tail position depends on the queue implementation); 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.

Parameters:

msg -

Returns:

Throws:

QueueException.QueueIsFull - if queue storage is full, can not take any more message

QueueException.CannotSerializeQueueMessage - if the supplied message can not be serialize

QueueException - other queue exceptions

finish

void finish(IQueueMessage<ID,DATA> msg)
     throws QueueException

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.

Parameters:

msg -

Throws:

QueueException

take

IQueueMessage<ID,DATA> take()
                           throws QueueException

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 ephemeral storage is full, can not put message to ephemeral storage

QueueException.CannotDeserializeQueueMessage - if the queue message can not be deserialized

QueueException - other queue exceptions

getOrphanMessages

Collection<IQueueMessage<ID,DATA>> getOrphanMessages(long thresholdTimestampMs)
                                                    throws QueueException.OperationNotSupported

Get all orphan messages (messages that were left in ephemeral storage for a long time).

Parameters:

thresholdTimestampMs - message is orphan if message's timestampMillis + thresholdTimestampMs < now . Which means getOrphanMessages(10000) will return orphan messages that have stayed in ephemeral storage for more than 10000 milliseconds.

Returns:

null or empty collection if there is no orphan message

Throws:

QueueException.OperationNotSupported

Since:

0.2.0

queueSize

int queueSize()
       throws QueueException

Get number of items currently in queue storage.

Returns:

negative number if queue size can not be queried

Throws:

QueueException

ephemeralSize

int ephemeralSize()
           throws QueueException

Get number of items currently in ephemeral storage.

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

Returns:

negative number if ephemeral size can not be queried

Throws:

QueueException