com.epam.fixengine.storage.queue

Class InMemoryQueue<T extends Queueable>

java.lang.Object

com.epam.fixengine.storage.queue.InMemoryQueue<T>

All Implemented Interfaces:

Queue<T>

Direct Known Subclasses:

MMFPersistentInMemoryQueue, PersistentInMemoryQueue

public class InMemoryQueue<T extends Queueable>
extends Object
implements Queue<T>

Memory queue implementation.

See Also:

Queueable

Field Summary

Fields

Modifier and Type	Field and Description
protected Queue<T>	application
protected Log	log
protected Map<byte[],Set<Integer>>	maskedTags
protected Queue<T>	session

Constructor Summary

Constructors

Constructor and Description
InMemoryQueue() Deprecated.
InMemoryQueue(com.epam.fixengine.configuration.Configuration conf) Create the memory queue.

Method Summary

Modifier and Type	Method and Description
boolean	add(T object) Add object to the queue.
boolean	addOutOfTurn(T object) Add object to the queue out of turn.
void	clear() Clears the queue.
void	clearOutOfTurn(Consumer<T> elementConsumer) Removes the elements which were added by addOutOfTurn.
void	commit() Removes polled object from the queue.
void	initialize() Initializes queue.
boolean	isAllEmpty()
boolean	isApplicationCommit() Return true if last commit was application.
boolean	isEmpty() Checks if queue is currently empty.
boolean	isOutOfTurnOnlyMode() Out of turn messages only mode.
protected boolean	isShutdown() Returns true if queue is shutdown.
void	notifyAllApplication() Notify a new application message exists.
void	notifyAllSession() Notify a new session message exists.
T	poll() Poll object from the queue (doesn't remove it from queue yet!).
void	setOutOfTurnOnlyMode(boolean newMode) Out of turn messages only mode.
void	shutdown() Gracefully shutdowns queue.
int	size() Returns current queue size.
Queueable[]	toArray() Return all objects in the queue as array.
int	totalSize() Returns current total queue size.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final Log log

application

protected final Queue<T extends Queueable> application

session

protected final Queue<T extends Queueable> session

maskedTags

protected Map<byte[],Set<Integer>> maskedTags

Constructor Detail

InMemoryQueue

@Deprecated
public InMemoryQueue()

Deprecated.

InMemoryQueue

public InMemoryQueue(com.epam.fixengine.configuration.Configuration conf)

Create the memory queue.

Method Detail

initialize

public void initialize()

Description copied from interface: Queue

Initializes queue. That includes restore of previously saved queue content for persistent queues.

Specified by:

initialize in interface Queue<T extends Queueable>

See Also:

Queue.initialize()

size

public int size()

Description copied from interface: Queue

Returns current queue size.

Specified by:

size in interface Queue<T extends Queueable>

Returns:

queue size

See Also:

Queue.size()

totalSize

public int totalSize()

Description copied from interface: Queue

Returns current total queue size. The total size of the usual queue and the OutOfTurn queue.

Specified by:

totalSize in interface Queue<T extends Queueable>

Returns:

queue size

See Also:

Queue.totalSize()

isEmpty

public boolean isEmpty()

Description copied from interface: Queue

Checks if queue is currently empty.

Specified by:

isEmpty in interface Queue<T extends Queueable>

Returns:

true if empty

See Also:

Queue.isEmpty()

isAllEmpty

public boolean isAllEmpty()

Specified by:

isAllEmpty in interface Queue<T extends Queueable>

add

public boolean add(T object)

Description copied from interface: Queue

Add object to the queue.

Specified by:

add in interface Queue<T extends Queueable>

Parameters:

object - the element

Returns:

true if element added successfully.

See Also:

Queue.add(Queueable)

addOutOfTurn

public boolean addOutOfTurn(T object)

Description copied from interface: Queue

Add object to the queue out of turn.

Specified by:

addOutOfTurn in interface Queue<T extends Queueable>

Parameters:

object - the element

Returns:

true if element added successfully.

See Also:

Queue.addOutOfTurn(Queueable)

poll

public T poll()

Description copied from interface: Queue

Poll object from the queue (doesn't remove it from queue yet!).

Specified by:

poll in interface Queue<T extends Queueable>

Returns:

the head of this queue, or null if this queue is empty

See Also:

Queue.poll()

setOutOfTurnOnlyMode

public void setOutOfTurnOnlyMode(boolean newMode)

Description copied from interface: Queue

Out of turn messages only mode.

Specified by:

setOutOfTurnOnlyMode in interface Queue<T extends Queueable>

Parameters:

newMode - the mode

See Also:

Queue.setOutOfTurnOnlyMode(boolean)

isOutOfTurnOnlyMode

public boolean isOutOfTurnOnlyMode()

Description copied from interface: Queue

Out of turn messages only mode.

Specified by:

isOutOfTurnOnlyMode in interface Queue<T extends Queueable>

clearOutOfTurn

public void clearOutOfTurn(Consumer<T> elementConsumer)

Description copied from interface: Queue

Removes the elements which were added by addOutOfTurn.

Specified by:

clearOutOfTurn in interface Queue<T extends Queueable>

Parameters:

elementConsumer - callback for each removed message. It is called after removing next message.

See Also:

Queue.clearOutOfTurn(Consumer)

commit

public void commit()

Description copied from interface: Queue

Removes polled object from the queue. If nothing was polled - throws IllegalStateException

Specified by:

commit in interface Queue<T extends Queueable>

See Also:

Queue.commit()

clear

public void clear()

Description copied from interface: Queue

Clears the queue.

Specified by:

clear in interface Queue<T extends Queueable>

See Also:

Queue.clear()

shutdown

public void shutdown()

Description copied from interface: Queue

Gracefully shutdowns queue.

Specified by:

shutdown in interface Queue<T extends Queueable>

See Also:

Queue.shutdown()

isShutdown

protected boolean isShutdown()

Returns true if queue is shutdown.

isApplicationCommit

public boolean isApplicationCommit()

Return true if last commit was application.

notifyAllApplication

public void notifyAllApplication()

Description copied from interface: Queue

Notify a new application message exists.

The methods works only if turn "mode on" is off.

Specified by:

notifyAllApplication in interface Queue<T extends Queueable>

See Also:

Queue.setOutOfTurnOnlyMode(boolean)

notifyAllSession

public void notifyAllSession()

Description copied from interface: Queue

Notify a new session message exists.

Specified by:

notifyAllSession in interface Queue<T extends Queueable>

toArray

public Queueable[] toArray()

Description copied from interface: Queue

Return all objects in the queue as array. Method has no impact on poll / commit operations.

Specified by:

toArray in interface Queue<T extends Queueable>

Returns:

array of Queueable