org.openorb.notify.queue
Interface EventQueue

All Known Subinterfaces:

FilterableEventQueue

All Known Implementing Classes:

DefaultEventQueue

public interface EventQueue

An event queue is an object into which events are pushed and pulled. Pushing an event is adding an event to this queue, pulling an event is retrieving an event from this queue. Events in the queue can be either Untyped, Structured, StructuredSequence and Type events.

Author:

Olivier Modica

Method Summary

int	getQueueSize() Return the current queue size
boolean	isEmpty() Indicate if the event queue is empty
java.lang.Object	pullEvent() Pull an event from the queue
boolean	pushEvent(java.lang.Object event) Push an event into the queue
boolean	pushEvent(java.lang.Object event, java.lang.Short priorityKey, java.lang.Long deadlineKey) Push an event into the queue
void	setOrderPolicy(int orderPolicy) Set the event queue order policy

Method Detail

setOrderPolicy

public void setOrderPolicy(int orderPolicy)

Set the event queue order policy

pushEvent

public boolean pushEvent(java.lang.Object event)

Push an event into the queue

pushEvent

public boolean pushEvent(java.lang.Object event,
                         java.lang.Short priorityKey,
                         java.lang.Long deadlineKey)

Push an event into the queue

pullEvent

public java.lang.Object pullEvent()

Pull an event from the queue

getQueueSize

public int getQueueSize()

Return the current queue size

isEmpty

public boolean isEmpty()

Indicate if the event queue is empty