org.d_haven.event.impl

Class DefaultPipe

public class DefaultPipe extends AbstractPipe

The default queue implementation is a variable size queue. This queue is thread safe, however the overhead in synchronization costs a few extra milliseconds.

Author: Berin Loritsch

Nested Class Summary
static class	DefaultPipe.DefaultPreparedEnqueue

Field Summary
List	m_elements
protected int	m_reserve The number of reserve items.

Constructor Summary
	DefaultPipe() Create an unbounded DefaultPipe.
	DefaultPipe(int size) Construct a new DefaultPipe with the specified number of elements. if the number of elements is greater than zero, then the `Pipe` is bounded by that number.
	DefaultPipe(EnqueuePredicate predicate) Construct a new DefaultPipe with the supplied EnqueuePredicate.

Method Summary
protected Object[]	doDequeue(int numElements)
protected Object	doDequeue()
protected Object[]	doDequeueAll()
protected void	doEnqueue(Object[] elements)
protected void	doEnqueue(Object element)
protected PreparedEnqueue	doPrepareEnqueue(Object[] elements)
static Object[]	retrieveElements(List buf, int count) Removes the given number of elements from the given `buf` and returns them in an array.
int	size() Return the number of elements currently in the `Pipe`.
String	toString() Get the string representation of this Pipe.

Field Detail

m_reserve

protected int m_reserve

The number of reserve items. The reserve items are items that are held in a PreparedEnqueue object, but have not been committed yet.

Constructor Detail

DefaultPipe

public DefaultPipe()

Create an unbounded DefaultPipe.

Construct a new DefaultPipe with the specified number of elements. if the number of elements is greater than zero, then the Pipe is bounded by that number. Otherwise, the Pipe is not bounded at all.

Parameters: size The maximum number of elements in the Pipe. Any number less than 1 means there is no limit.

DefaultPipe

public DefaultPipe(EnqueuePredicate predicate)

Construct a new DefaultPipe with the supplied EnqueuePredicate.

Parameters: predicate the EnqueuePredicate to use

Parameters: buf to remove elements from, the caller is responsible for synchronizing access count number of elements to remove/return

Returns: requested number of elements

size

public int size()

Return the number of elements currently in the Pipe.

Returns: int representing the number of elements (including the reserved ones).

toString

public String toString()

Get the string representation of this Pipe.

Returns: the string message