ome.smuggler.core.msg

Class SourceQueue<M,D>

java.lang.Object

ome.smuggler.core.msg.SourceQueue<M,D>

All Implemented Interfaces:

ChannelSource<ChannelMessage<M,D>>, MessageSource<M,D>

public class SourceQueue<M,D>
extends java.lang.Object
implements MessageSource<M,D>

A channel source that queues messages in memory and allows to retrieve the head of the queue to consume messages or do a bulk retrieval of all queued messages.

Constructor Summary

Constructors

Constructor and Description
SourceQueue() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
java.util.List<ChannelMessage<M,D>>	dequeue() Removes all the items currently in the queue, returning them in FIFO order.
java.util.List<D>	dequeueData() Same as dequeue() but discards message metadata.
java.util.Optional<ChannelMessage<M,D>>	head()
java.util.Optional<D>	headData() Same as head() but discards message metadata.
void	send(ChannelMessage<M,D> msg) Inputs data into the channel and returns immediately.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ome.smuggler.core.msg.MessageSource

asDataSource

Methods inherited from interface ome.smuggler.core.msg.ChannelSource

uncheckedSend

Constructor Detail

SourceQueue

public SourceQueue()

Creates a new instance.

Method Detail

send

public void send(ChannelMessage<M,D> msg)
          throws java.lang.Exception

Description copied from interface: ChannelSource

Inputs data into the channel and returns immediately. This is an asynchronous operation, so that the sender never waits for the receiver to get the data.

Specified by:

send in interface ChannelSource<ChannelMessage<M,D>>

Parameters:

msg - the message to send.

Throws:

java.lang.NullPointerException - if the input is null.

java.lang.Exception - if the data could not be input into the channel.

head

public java.util.Optional<ChannelMessage<M,D>> head()

Returns:

the oldest message item (metadata + data) on the queue or empty if the queue has no items.

headData

public java.util.Optional<D> headData()

Same as head() but discards message metadata.

Returns:

the data of the oldest message item on the queue or empty if the queue has no items.

dequeue

public java.util.List<ChannelMessage<M,D>> dequeue()

Removes all the items currently in the queue, returning them in FIFO order.

Returns:

the items in the queue or empty if the queue has no items.

dequeueData

public java.util.List<D> dequeueData()

Same as dequeue() but discards message metadata.

Returns:

the data in each queued message or empty if the queue has no items.