com.jenjinstudios.io.concurrency

Class MessageQueue<T extends ExecutionContext>

java.lang.Object

com.jenjinstudios.io.concurrency.MessageQueue<T>

public class MessageQueue<T extends ExecutionContext>
extends java.lang.Object

Queues incoming and outgoing messages in a thread-safe manner.

Constructor Summary

Constructors

Constructor and Description
MessageQueue() Construct a new MessageQueue.
MessageQueue(java.util.Collection<RecurringTask<T>> recurringTasks) Construct a new MessageQueue with the given recurring tasks.

Method Summary

Modifier and Type	Method and Description
void	errorEncountered(java.lang.Throwable throwable) Indicate than an exception has occurred and store the exception in the queue.
java.util.List<java.lang.Throwable>	getErrorsAndClear() Get any errors reported to this queue and clear the internal list.
java.util.List<Message>	getIncomingAndClear() Get all messages that have been received since the last time this method was called, and clear the internal list.
java.util.List<Message>	getOutgoingAndClear() Get all messages that have been queued since the last time this method was called, and clear the internal list.
java.util.Collection<RecurringTask<T>>	getRecurringTasks()
void	messageReceived(Message message) Indicate that a message has been received and add it to the incoming queue.
void	queueOutgoing(Message message) Queue an outgoing message.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageQueue

public MessageQueue()

Construct a new MessageQueue.

MessageQueue

public MessageQueue(java.util.Collection<RecurringTask<T>> recurringTasks)

Construct a new MessageQueue with the given recurring tasks.

Parameters:

recurringTasks - The recurring tasks.

Method Detail

messageReceived

public void messageReceived(Message message)

Indicate that a message has been received and add it to the incoming queue.

Parameters:

message - The message that has been received.

getIncomingAndClear

public java.util.List<Message> getIncomingAndClear()

Get all messages that have been received since the last time this method was called, and clear the internal list.

Returns:

A List of messages that have been received since the last time this method was called.

queueOutgoing

public void queueOutgoing(Message message)

Queue an outgoing message.

Parameters:

message - The message to be queued.

getOutgoingAndClear

public java.util.List<Message> getOutgoingAndClear()

Get all messages that have been queued since the last time this method was called, and clear the internal list.

Returns:

A List of messages that have been queued since the last time this method was called.

errorEncountered

public void errorEncountered(java.lang.Throwable throwable)

Indicate than an exception has occurred and store the exception in the queue.

Parameters:

throwable - The exception.

getErrorsAndClear

public java.util.List<java.lang.Throwable> getErrorsAndClear()

Get any errors reported to this queue and clear the internal list.

Returns:

A List of errors reported to this queue.

getRecurringTasks

public java.util.Collection<RecurringTask<T>> getRecurringTasks()