org.jacorb.notification.queue

Interface MessageQueue

public interface MessageQueue

Version: $Id: MessageQueue.java,v 1.2 2005/08/21 13:32:36 alphonse.bendt Exp $

Author: Alphonse Bendt

Nested Class Summary
static interfaceMessageQueue.DiscardListener
Method Summary
voidaddDiscardListener(MessageQueue.DiscardListener listener)
Message[]getAllMessages(boolean wait)
get all Messages from this queue.
StringgetDiscardPolicyName()
MessagegetMessage(boolean wait)
get the next Message from this queue. which particular event is selected depends on the underlying implementation.
Message[]getMessages(int n, boolean wait)
get up to n events from this queue.
StringgetOrderPolicyName()
intgetSize()
access the current size of this queue.
booleanisEmpty()
check if this queue is empty.
voidput(Message event)
put a Message into this queue.
voidremoveDiscardListener(MessageQueue.DiscardListener listener)

Method Detail

addDiscardListener

public void addDiscardListener(MessageQueue.DiscardListener listener)

getAllMessages

public Message[] getAllMessages(boolean wait)
get all Messages from this queue.

Parameters: wait a boolean value. If this parameter is set to true the queue will block until an element is available. If the parameter is set to false the queue will return null in case it is empty.

getDiscardPolicyName

public String getDiscardPolicyName()

getMessage

public Message getMessage(boolean wait)
get the next Message from this queue. which particular event is selected depends on the underlying implementation.

Parameters: wait a boolean value. If this parameter is set to true the queue will block until an element is available. If the parameter is set to false the queue will return null in case it is empty.

Throws: InterruptedException

getMessages

public Message[] getMessages(int n, boolean wait)
get up to n events from this queue.

Parameters: n number of requested messages wait a boolean value. If this parameter is set to true the queue will block until an element is available. If the parameter is set to false the queue will return null in case it is empty.

getOrderPolicyName

public String getOrderPolicyName()

getSize

public int getSize()
access the current size of this queue.

isEmpty

public boolean isEmpty()
check if this queue is empty.

put

public void put(Message event)
put a Message into this queue.

removeDiscardListener

public void removeDiscardListener(MessageQueue.DiscardListener listener)