com.sap.netweaver.bc.rf.util.event

Class EventQueue

java.lang.Object
  com.sap.netweaver.bc.rf.util.event.EventQueue

public class EventQueue
extends Object

A blocking FIFO queue of events. Event consumers (EventSenderThread) are blocked on an empty queue until new events are avialable.

Method Summary

IEvent	dequeue() Dequeues an event (removes the first from the list).
IEvent[]	dequeue(int num) Dequeues the specified number of events.
boolean	enqueue(IEvent event) Enqueues an event (adds it to the ebd of the list).

Methods inherited from class java.lang.Object

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

Method Detail

enqueue

public boolean enqueue(IEvent event)

Enqueues an event (adds it to the ebd of the list).

Parameters:

event - event to be enqueued

Returns:

true if the event was enqueued and false when the maximum size of the queue has been reached

dequeue

public IEvent dequeue()

Dequeues an event (removes the first from the list). If the queue is empty the calling thread is blocked until new events are available.

Returns:

The event from the queue

dequeue

public IEvent[] dequeue(int num)

Dequeues the specified number of events. If the current size of the queue is smaller than the specified number the size of the returned array will be equal to the current size of the queue. If the queue is empty the calling thread is blocked until new events are available.

Parameters:

num - number of events to dequeue.

Returns:

array of events (the size can be smaller than the specified number)

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM