Package org.jgroups.util

Class SizeBoundedQueue

java.lang.Object

org.jgroups.util.SizeBoundedQueue

All Implemented Interfaces:

Iterable, Collection, BlockingQueue, Queue

public class SizeBoundedQueue
extends Object
implements BlockingQueue

Queue as described in http://jira.jboss.com/jira/browse/JGRP-376. However, this queue only works with TP.IncomingPacket elements. The queue maintains a max number of bytes and a total of all of the messages in the internal queues. Whenever a message is added, we increment the total by the length of the message. When a message is removed, we decrement the total. Removal blocks until a message is available, addition blocks if the max size has been exceeded, until there is enough space to add another message. Note that the max size should always be greater than the size of the largest message to be received, otherwise an additon would always fail because msg.length > max size !
Access patterns: this instance is always accessed by the thread pool only ! Concurrent take() or poll() methods, but only a single thread at a time calls put() !

Version:

$Id: SizeBoundedQueue.java,v 1.3 2006/12/31 14:29:52 belaban Exp $

Author:

Bela Ban

Constructor Summary

Constructors

Constructor	Description
SizeBoundedQueue()

Method Summary

Modifier and Type	Method	Description
boolean	add(Object o)
boolean	addAll(Collection c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection c)
int	drainTo(Collection c)
int	drainTo(Collection c, int maxElements)
Object	element()
boolean	isEmpty()
Iterator	iterator()
boolean	offer(Object o)
boolean	offer(Object o, long timeout, TimeUnit unit)
Object	peek()
Object	poll()
Object	poll(long timeout, TimeUnit unit)
void	put(Object o)
int	remainingCapacity()
Object	remove()
boolean	remove(Object o)
boolean	removeAll(Collection c)
boolean	retainAll(Collection c)
int	size()
Object	take()
Object[]	toArray()
Object[]	toArray(Object[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Constructor Details

SizeBoundedQueue

public SizeBoundedQueue()

Method Details

add

public boolean add(Object o)

Specified by:

add in interface BlockingQueue

Specified by:

add in interface Collection

Specified by:

add in interface Queue

drainTo

public int drainTo(Collection c)

Specified by:

drainTo in interface BlockingQueue

drainTo

public int drainTo(Collection c,
 int maxElements)

Specified by:

drainTo in interface BlockingQueue

offer

public boolean offer(Object o)

Specified by:

offer in interface BlockingQueue

Specified by:

offer in interface Queue

offer

public boolean offer(Object o,
 long timeout,
 TimeUnit unit)
              throws InterruptedException

Specified by:

offer in interface BlockingQueue

Throws:

InterruptedException

poll

public Object poll(long timeout,
 TimeUnit unit)
            throws InterruptedException

Specified by:

poll in interface BlockingQueue

Throws:

InterruptedException

put

public void put(Object o)
         throws InterruptedException

Specified by:

put in interface BlockingQueue

Throws:

InterruptedException

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue

take

public Object take()
            throws InterruptedException

Specified by:

take in interface BlockingQueue

Throws:

InterruptedException

element

public Object element()

Specified by:

element in interface Queue

peek

public Object peek()

Specified by:

peek in interface Queue

poll

public Object poll()

Specified by:

poll in interface Queue

remove

public Object remove()

Specified by:

remove in interface Queue

addAll

public boolean addAll(Collection c)

Specified by:

addAll in interface Collection

clear

public void clear()

Specified by:

clear in interface Collection

contains

public boolean contains(Object o)

Specified by:

contains in interface BlockingQueue

Specified by:

contains in interface Collection

containsAll

public boolean containsAll(Collection c)

Specified by:

containsAll in interface Collection

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection

iterator

public Iterator iterator()

Specified by:

iterator in interface Collection

Specified by:

iterator in interface Iterable

remove

public boolean remove(Object o)

Specified by:

remove in interface BlockingQueue

Specified by:

remove in interface Collection

removeAll

public boolean removeAll(Collection c)

Specified by:

removeAll in interface Collection

retainAll

public boolean retainAll(Collection c)

Specified by:

retainAll in interface Collection

size

public int size()

Specified by:

size in interface Collection

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection

toArray

public Object[] toArray(Object[] a)

Specified by:

toArray in interface Collection