org.openksavi.sponge.core.engine.processing.decomposed

Class DecomposedQueue<T extends EventProcessorAdapter<?>>

java.lang.Object

org.openksavi.sponge.core.engine.processing.decomposed.DecomposedQueue<T>

All Implemented Interfaces:

EventProcessorRegistrationListener<T>

public class DecomposedQueue<T extends EventProcessorAdapter<?>>
extends Object
implements EventProcessorRegistrationListener<T>

Decomposed custom queue of entries (trigger adapter or event set processor group adapter, event).

Constructor Summary

Constructors

Constructor and Description
DecomposedQueue(int capacity, boolean allowConcurrentEventTypeProcessing)

Method Summary

Modifier and Type	Method and Description
protected org.apache.commons.lang3.tuple.Pair<T,Event>	doGetNonBlocking() Returns the next pair (trigger adapter or event set processor group adapter) available to processing.
org.apache.commons.lang3.tuple.Pair<T,Event>	get(long timeout, TimeUnit unit) Returns the next pair (trigger adapter or event set processor group adapter) available to processing.
int	getCapacity()
int	getSize()
void	onProcessorAdded(T eventProcessorAdapter)
void	onProcessorRemoved(T eventProcessorAdapter)
boolean	put(org.apache.commons.lang3.tuple.Pair<T,Event> entry) Puts a new entry (trigger adapter or event set processor group adapter, event) at the end of this decomposed queue.
void	release(org.apache.commons.lang3.tuple.Pair<T,Event> entry) Releases trigger adapter or event set processor group adapter after the completion of processing the event.

Methods inherited from class java.lang.Object

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

Constructor Detail

DecomposedQueue

public DecomposedQueue(int capacity,
                       boolean allowConcurrentEventTypeProcessing)

Method Detail

put

public boolean put(org.apache.commons.lang3.tuple.Pair<T,Event> entry)

Puts a new entry (trigger adapter or event set processor group adapter, event) at the end of this decomposed queue.

Parameters:

entry - a pair (trigger adapter or event set processor group adapter).

Returns:

false if the queue is full and can't accept any new entry.

get

public org.apache.commons.lang3.tuple.Pair<T,Event> get(long timeout,
                                                        TimeUnit unit)
                                                 throws InterruptedException

Returns the next pair (trigger adapter or event set processor group adapter) available to processing. Trigger adapter is always ready to process an event because it is a singleton. Event set processor group adapter is ready to process an event only one at a time, i.e. processed events sequentially to preserve event order.

This method is blocking.

When timeout occurs null is returned.

If this method returns non-null value, you have to invoke release after the processing by the returned adapter completes.

Parameters:

timeout - how long to wait before giving up, in units of unit.

unit - unit a TimeUnit determining how to interpret the timeout parameter.

Returns:

the next pair (trigger adapter or event set processor group adapter) available to processing.

Throws:

InterruptedException - if interrupted while waiting.

doGetNonBlocking

protected org.apache.commons.lang3.tuple.Pair<T,Event> doGetNonBlocking()

Returns the next pair (trigger adapter or event set processor group adapter) available to processing.

Not-Blocking.

Returns null if currently there is no pair (trigger adapter or event set processor group adapter) available to processing.

Returns:

the next pair (trigger adapter or event set processor group adapter) available to processing or null if none found.

release

public void release(org.apache.commons.lang3.tuple.Pair<T,Event> entry)

Releases trigger adapter or event set processor group adapter after the completion of processing the event.

Parameters:

entry - an entry.

onProcessorAdded

public void onProcessorAdded(T eventProcessorAdapter)

Specified by:

onProcessorAdded in interface EventProcessorRegistrationListener<T extends EventProcessorAdapter<?>>

onProcessorRemoved

public void onProcessorRemoved(T eventProcessorAdapter)

Specified by:

onProcessorRemoved in interface EventProcessorRegistrationListener<T extends EventProcessorAdapter<?>>

getCapacity

public int getCapacity()

getSize

public int getSize()