com.solacesystems.jcsmp.impl.queues

Class ConditionalBoundedMessageQueue

java.lang.Object

com.solacesystems.jcsmp.impl.queues.ConditionalBoundedMessageQueue

All Implemented Interfaces:

Iterable<JCSMPXMLMessage>

public class ConditionalBoundedMessageQueue
extends Object
implements Iterable<JCSMPXMLMessage>

Constructor Summary

Constructors

Constructor and Description
ConditionalBoundedMessageQueue(int capacity, boolean fair, Callable<?> onEnqueueOnFull) Creates an ArrayBlockingQueue with the given (fixed) capacity and the specified access policy.
ConditionalBoundedMessageQueue(int capacity, Callable<?> onEnqueueOnFull) Creates an ArrayBlockingQueue with the given (fixed) capacity and default access policy.

Method Summary

Modifier and Type	Method and Description
void	activate()
void	clear() Atomically removes all of the elements from this queue.
boolean	contains(Object o)
int	copyTo(Collection<JCSMPXMLMessage> c)
void	deactivate()
int	drainTo(Collection<JCSMPXMLMessage> c)
int	drainTo(Collection<JCSMPXMLMessage> c, int maxElements)
boolean	isEmpty()
boolean	isFull()
Iterator<JCSMPXMLMessage>	iterator() Returns an iterator over the elements in this queue in proper sequence.
int	msgIdRenumbering(long lastMsgIdSent)
JCSMPXMLMessage	peek()
JCSMPXMLMessage	poll()
int	processElements(ProcessElementsTask task)
void	queueMsgWithIdUpdate(JCSMPXMLMessage o, PubADManager adMgr) updates message ID of the specified message before adds it to the tail of this queue, waiting if necessary for space to become available or the queue is resumed.
int	remainingCapacity() Returns the number of elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking.
boolean	remove(Object o) Removes a single instance of the specified element from this queue, if it is present.
void	resume()
int	size() Returns the number of elements in this queue.
void	suspend()
JCSMPXMLMessage	take()
Object[]	toArray()
JCSMPXMLMessage[]	toArray(JCSMPXMLMessage[] a)
String	toString()
void	waitUntilEmpty()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ConditionalBoundedMessageQueue

public ConditionalBoundedMessageQueue(int capacity,
                                      Callable<?> onEnqueueOnFull)

Creates an ArrayBlockingQueue with the given (fixed) capacity and default access policy.

Parameters:

capacity - the capacity of this queue

Throws:

IllegalArgumentException - if capacity is less than 1

ConditionalBoundedMessageQueue

public ConditionalBoundedMessageQueue(int capacity,
                                      boolean fair,
                                      Callable<?> onEnqueueOnFull)

Creates an ArrayBlockingQueue with the given (fixed) capacity and the specified access policy.

Parameters:

capacity - the capacity of this queue

fair - if true then queue accesses for threads blocked on insertion or removal, are processed in FIFO order; if false the access order is unspecified.

Throws:

IllegalArgumentException - if capacity is less than 1

Method Detail

poll

public JCSMPXMLMessage poll()

remove

public boolean remove(Object o)

Removes a single instance of the specified element from this queue, if it is present.

peek

public JCSMPXMLMessage peek()

take

public JCSMPXMLMessage take()
                     throws InterruptedException

Throws:

InterruptedException

queueMsgWithIdUpdate

public void queueMsgWithIdUpdate(JCSMPXMLMessage o,
                                 PubADManager adMgr)
                          throws InterruptedException,
                                 InvalidOperationException

updates message ID of the specified message before adds it to the tail of this queue, waiting if necessary for space to become available or the queue is resumed.

Parameters:

o - the element to add

Throws:

InterruptedException - if interrupted while waiting.

NullPointerException - if the specified element is null.

InvalidOperationException

size

public int size()

Returns the number of elements in this queue.

Returns:

the number of elements in this queue.

isEmpty

public boolean isEmpty()

isFull

public boolean isFull()

remainingCapacity

public int remainingCapacity()

Returns the number of elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking. This is always equal to the initial capacity of this queue less the current size of this queue.

Note that you cannot always tell if an attempt to add an element will succeed by inspecting remainingCapacity because it may be the case that a waiting consumer is ready to take an element out of an otherwise full queue.

contains

public boolean contains(Object o)

toArray

public Object[] toArray()

toArray

public JCSMPXMLMessage[] toArray(JCSMPXMLMessage[] a)

toString

public String toString()

Overrides:

toString in class Object

clear

public void clear()

Atomically removes all of the elements from this queue. The queue will be empty after this call returns.

drainTo

public int drainTo(Collection<JCSMPXMLMessage> c)

drainTo

public int drainTo(Collection<JCSMPXMLMessage> c,
                   int maxElements)

copyTo

public int copyTo(Collection<JCSMPXMLMessage> c)

msgIdRenumbering

public int msgIdRenumbering(long lastMsgIdSent)

suspend

public void suspend()

resume

public void resume()

processElements

public int processElements(ProcessElementsTask task)
                    throws JCSMPException

Throws:

JCSMPException

deactivate

public void deactivate()

activate

public void activate()

waitUntilEmpty

public void waitUntilEmpty()
                    throws InterruptedException

Throws:

InterruptedException

iterator

public Iterator<JCSMPXMLMessage> iterator()

Returns an iterator over the elements in this queue in proper sequence. The returned Iterator is a "weakly consistent" iterator that will never throw ConcurrentModificationException, and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction.

Specified by:

iterator in interface Iterable<JCSMPXMLMessage>

Returns:

an iterator over the elements in this queue in proper sequence.