Package com.github.ddth.queue.impl

Class AbstractInmemEphemeralQueue<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.AbstractInmemEphemeralQueue<ID,DATA>

All Implemented Interfaces:

IQueue<ID,DATA>, AutoCloseable

Direct Known Subclasses:

DisruptorQueue, InmemQueue

public abstract class AbstractInmemEphemeralQueue<ID,DATA>
extends AbstractEphemeralSupportQueue<ID,DATA>

Abstract queue implementation that uses in-memory ephemeral storage.

Since:

1.0.0

Author:

Thanh Nguyen

Nested Class Summary

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

AbstractQueue.PutToQueueCase

Field Summary

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

SIZE_NOT_SUPPORTED

Constructor Summary

Constructors

Constructor	Description
AbstractInmemEphemeralQueue()

Method Summary

Modifier and Type	Method	Description
protected void	doPutToEphemeralStorage(IQueueMessage<ID,DATA> msg)
protected void	doRemoveFromEphemeralStorage(IQueueMessage<ID,DATA> msg)
protected void	ensureEphemeralSize()
int	ephemeralSize()	Get number of items currently in ephemeral storage.
Collection<IQueueMessage<ID,DATA>>	getOrphanMessages(long thresholdTimestampMs)	Get all orphan messages (messages that were left in ephemeral storage for a long time).
protected void	initEphemeralStorage(int hintSize)
AbstractInmemEphemeralQueue<ID,DATA>	setEphemeralDisabled(boolean ephemeralDisabled)	Disable/Enable ephemeral storage.

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

getEphemeralDisabled, getEphemeralMaxSize, isEphemeralDisabled, setEphemeralMaxSize

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

close, createMessage, createMessage, createMessage, deserialize, deserialize, destroy, doPutToQueue, getMessageFactory, getQueueName, getSerDeser, init, 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

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

finish, queueSize, take

Constructor Detail

AbstractInmemEphemeralQueue

public AbstractInmemEphemeralQueue()

Method Detail

setEphemeralDisabled

public AbstractInmemEphemeralQueue<ID,DATA> setEphemeralDisabled(boolean ephemeralDisabled)

Description copied from class: AbstractEphemeralSupportQueue

Disable/Enable ephemeral storage.

Overrides:

setEphemeralDisabled in class AbstractEphemeralSupportQueue<ID,DATA>

Parameters:

ephemeralDisabled - true to disable ephemeral storage, false otherwise.

Returns:

initEphemeralStorage

protected void initEphemeralStorage(int hintSize)

doRemoveFromEphemeralStorage

protected void doRemoveFromEphemeralStorage(IQueueMessage<ID,DATA> msg)

ensureEphemeralSize

protected void ensureEphemeralSize()

doPutToEphemeralStorage

protected void doPutToEphemeralStorage(IQueueMessage<ID,DATA> msg)

getOrphanMessages

public Collection<IQueueMessage<ID,DATA>> getOrphanMessages(long thresholdTimestampMs)

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

ephemeralSize

public int ephemeralSize()

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