|
Colt 1.0.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--edu.oswego.cs.dl.util.concurrent.BoundedBuffer
Efficient array-based bounded buffer class. Adapted from CPJ, chapter 8, which describes design.
[ Introduction to this package. ]
Constructor Summary | |
BoundedBuffer()
Create a buffer with the current default capacity |
|
BoundedBuffer(int capacity)
Create a BoundedBuffer with the given capacity. |
Method Summary | |
int |
capacity()
Return the maximum number of elements that can be held. |
boolean |
offer(Object x,
long msecs)
Place item in channel only if it can be accepted within msecs milliseconds. |
Object |
peek()
Return, but do not remove object at head of Channel, or null if it is empty. |
Object |
poll(long msecs)
Return and remove an item from channel only if one is available within msecs milliseconds. |
void |
put(Object x)
Place item in the channel, possibly waiting indefinitely until it can be accepted. |
int |
size()
Return the number of elements in the buffer. |
Object |
take()
Return and remove an item from channel, possibly waiting indefinitely until such an item exists. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public BoundedBuffer()
public BoundedBuffer(int capacity) throws IllegalArgumentException
IllegalArgumentException
- if capacity less or equal to zeroMethod Detail |
public int capacity()
BoundedChannel
capacity
in interface BoundedChannel
edu.oswego.cs.dl.util.concurrent.BoundedChannel
public boolean offer(Object x, long msecs) throws InterruptedException
Channel
offer
in interface Channel
edu.oswego.cs.dl.util.concurrent.Channel
item
- the element to be inserted. Should be non-null.msecs
- the number of milliseconds to wait. If less than
or equal to zero, the method does not perform any timed waits,
but might still require
access to a synchronization lock, which can impose unbounded
delay if there is a lot of contention for the channel.InterruptedException
- if the current thread has
been interrupted at a point at which interruption
is detected, in which case the element is guaranteed not
to be inserted (i.e., is equivalent to a false return).public Object peek()
Channel
peek
in interface Channel
public Object poll(long msecs) throws InterruptedException
Channel
poll
in interface Channel
edu.oswego.cs.dl.util.concurrent.Channel
msecs
- the number of milliseconds to wait. If less than
or equal to zero, the operation does not perform any timed waits,
but might still require
access to a synchronization lock, which can impose unbounded
delay if there is a lot of contention for the channel.InterruptedException
- if the current thread has
been interrupted at a point at which interruption
is detected, in which case state of the channel is unchanged
(i.e., equivalent to a false return).public void put(Object x) throws InterruptedException
Channel
put
in interface Channel
edu.oswego.cs.dl.util.concurrent.Channel
item
- the element to be inserted. Should be non-null.InterruptedException
- if the current thread has
been interrupted at a point at which interruption
is detected, in which case the element is guaranteed not
to be inserted. Otherwise, on normal return, the element is guaranteed
to have been inserted.public int size()
public Object take() throws InterruptedException
Channel
take
in interface Channel
edu.oswego.cs.dl.util.concurrent.Channel
InterruptedException
- if the current thread has
been interrupted at a point at which interruption
is detected, in which case state of the channel is unchanged.
|
Colt 1.0.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |