dk.dma.ais.queue

Class BlockingMessageQueue<T>

java.lang.Object

dk.dma.ais.queue.BlockingMessageQueue<T>

Type Parameters:

T - the type parameter

All Implemented Interfaces:

IMessageQueue<T>

@ThreadSafe
public class BlockingMessageQueue<T>
extends Object
implements IMessageQueue<T>

Implementation of a IMessageQueue using a Java ArrayBlockingQueue

Constructor Summary

Constructors

Constructor and Description
BlockingMessageQueue() Instantiates a new Blocking message queue.
BlockingMessageQueue(int limit) Instantiates a new Blocking message queue.

Method Summary

Modifier and Type	Method and Description
int	getLimit() Gets limit.
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> l) 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

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockingMessageQueue

public BlockingMessageQueue()

Instantiates a new Blocking message queue.

BlockingMessageQueue

public BlockingMessageQueue(int limit)

Instantiates a new Blocking message queue.

Parameters:

limit - the limit

Method Detail

push

public int push(T content)
         throws MessageQueueOverflowException

Description copied from interface: IMessageQueue

Push AisMessage onto the queue

Specified by:

push in interface IMessageQueue<T>

Parameters:

content - the content

Returns:

the number of elements on the queue after the insertion

Throws:

MessageQueueOverflowException - when capacity limit has been reached

put

public int put(T content)
        throws InterruptedException

Description copied from interface: IMessageQueue

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

Specified by:

put in interface IMessageQueue<T>

Parameters:

content - the content

Returns:

int int

Throws:

InterruptedException - the interrupted exception

pull

public T pull()
       throws InterruptedException

Description copied from interface: IMessageQueue

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

Specified by:

pull in interface IMessageQueue<T>

Returns:

AisMessageQueueEntry t

Throws:

InterruptedException - the interrupted exception

pull

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

Description copied from interface: IMessageQueue

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

Specified by:

pull in interface IMessageQueue<T>

Parameters:

l - list to add elements to

maxElements - the max elements

Returns:

list with added elements

Throws:

InterruptedException - the interrupted exception

pullAll

public List<T> pullAll(List<T> l)
                throws InterruptedException

Description copied from interface: IMessageQueue

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

Specified by:

pullAll in interface IMessageQueue<T>

Parameters:

l - the c

Returns:

list with added elements

Throws:

InterruptedException - the interrupted exception

getLimit

public int getLimit()

Gets limit.

Returns:

the limit