Apache/commons-collections
1
0
Fork 0
mirror of https://github.com/apache/commons-collections.git synced 2025-02-17 23:44:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

27691: Adding timeout versions of get() and remove()

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@170761 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
James W. Carman 2005-05-18 15:03:02 +00:00
parent e297d23839
commit 61173f58aa
2 changed files with 87 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
src/java/org/apache/commons/collections/buffer/BlockingBuffer.java
View File

@ -25,29 +25,29 @@ import org.apache.commons.collections.BufferUnderflowException;
/**
* Decorates another <code>Buffer</code> to make {@link #get()} and
* {@link #remove()} block when the <code>Buffer</code> is empty.
* <p>
* <p/>
* If either <code>get</code> or <code>remove</code> is called on an empty
* <code>Buffer</code>, the calling thread waits for notification that
* an <code>add</code> or <code>addAll</code> operation has completed.
* <p>
* <p/>
* When one or more entries are added to an empty <code>Buffer</code>,
* all threads blocked in <code>get</code> or <code>remove</code> are notified.
* There is no guarantee that concurrent blocked <code>get</code> or
* <code>remove</code> requests will be "unblocked" and receive data in the
* order that they arrive.
* <p>
* <p/>
* This class is Serializable from Commons Collections 3.1.
*
* @since Commons Collections 3.0
* @version $Revision$ $Date$
*
* @author Stephen Colebourne
* @author Janek Bogucki
* @author Phil Steitz
* @version $Revision$ $Date$
* @since Commons Collections 3.0
*/
public class BlockingBuffer extends SynchronizedBuffer {
/** Serialization version */
/**
* Serialization version
*/
private static final long serialVersionUID = 1719328905017860541L;
/**
@ -94,7 +94,8 @@ public class BlockingBuffer extends SynchronizedBuffer {
while(collection.isEmpty()) {
try {
wait();
} catch (InterruptedException e) {
}
catch(InterruptedException e) {
PrintWriter out = new PrintWriter(new StringWriter());
e.printStackTrace(out);
throw new BufferUnderflowException("Caused by InterruptedException: " + out.toString());
@ -104,12 +105,35 @@ public class BlockingBuffer extends SynchronizedBuffer {
}
}
public Object get(final long timeout) {
synchronized(lock) {
final long expiration = System.currentTimeMillis() + timeout;
long timeLeft = expiration - System.currentTimeMillis();
while(timeLeft > 0 && collection.isEmpty()) {
try {
wait(timeLeft);
timeLeft = expiration - System.currentTimeMillis();
}
catch(InterruptedException e) {
PrintWriter out = new PrintWriter(new StringWriter());
e.printStackTrace(out);
throw new BufferUnderflowException("Caused by InterruptedException: " + out.toString());
}
}
if(collection.isEmpty()) {
throw new BufferUnderflowException("Timeout expired.");
}
return getBuffer().get();
}
}
public Object remove() {
synchronized(lock) {
while(collection.isEmpty()) {
try {
wait();
} catch (InterruptedException e) {
}
catch(InterruptedException e) {
PrintWriter out = new PrintWriter(new StringWriter());
e.printStackTrace(out);
throw new BufferUnderflowException("Caused by InterruptedException: " + out.toString());
@ -119,4 +143,25 @@ public class BlockingBuffer extends SynchronizedBuffer {
}
}
public Object remove(final long timeout) {
synchronized(lock) {
final long expiration = System.currentTimeMillis() + timeout;
long timeLeft = expiration - System.currentTimeMillis();
while(timeLeft > 0 && collection.isEmpty()) {
try {
wait(timeLeft);
timeLeft = expiration - System.currentTimeMillis();
}
catch(InterruptedException e) {
PrintWriter out = new PrintWriter(new StringWriter());
e.printStackTrace(out);
throw new BufferUnderflowException("Caused by InterruptedException: " + out.toString());
}
}
if(collection.isEmpty()) {
throw new BufferUnderflowException("Timeout expired.");
}
return getBuffer().remove();
}
}
}

19
src/test/org/apache/commons/collections/buffer/TestBlockingBuffer.java
View File

@ -365,6 +365,25 @@ public class TestBlockingBuffer extends AbstractTestObject {
}
public void testTimeoutGet() {
final BlockingBuffer buffer = new BlockingBuffer(new MyBuffer());
try {
buffer.get( 100 );
fail( "Get should have timed out." );
}
catch( BufferUnderflowException e ){
}
}
public void testTimeoutRemove() {
final BlockingBuffer buffer = new BlockingBuffer(new MyBuffer());
try {
buffer.remove( 100 );
fail( "Get should have timed out." );
}
catch( BufferUnderflowException e ){
}
}
protected static class DelayedAdd extends Thread {
Buffer buffer;