dk.dma.ais.queue

Interface IMessageQueue<T>

Type Parameters:

T - the type parameter

All Known Implementing Classes:

BlockingMessageQueue

@ThreadSafe
public interface IMessageQueue<T>

Queue for transporting various data. Suited for AIS use.

Method Summary

Modifier and Type	Method and Description
T	pull() Pull message from the queue.
List<T>	pull(List<T> l, int maxElements) Pull up to maxElements from queue.
List<T>	pullAll(List<T> c) Pull all current message on the queue.
int	push(T content) Push AisMessage onto the queue
int	put(T content) Push the specified element on the queue, waiting if necessary for space to become availably

Method Detail

push

int push(T content)
  throws MessageQueueOverflowException

Push AisMessage onto the queue

Parameters:

content - the content

Returns:

the number of elements on the queue after the insertion

Throws:

MessageQueueOverflowException - when capacity limit has been reached

put

int put(T content)
 throws InterruptedException

Push the specified element on the queue, waiting if necessary for space to become availably

Parameters:

content - the content

Returns:

int int

Throws:

InterruptedException - the interrupted exception

pull

T pull()
throws InterruptedException

Pull message from the queue. This must be implemented as a blocking call.

Returns:

AisMessageQueueEntry t

Throws:

InterruptedException - the interrupted exception

pull

List<T> pull(List<T> l,
             int maxElements)
      throws InterruptedException

Pull up to maxElements from queue. This must be a blocking call.

Parameters:

l - list to add elements to

maxElements - the max elements

Returns:

list with added elements

Throws:

InterruptedException - the interrupted exception

pullAll

List<T> pullAll(List<T> c)
         throws InterruptedException

Pull all current message on the queue. This must be a blocking call.

Parameters:

c - the c

Returns:

list with added elements

Throws:

InterruptedException - the interrupted exception