EDU.oswego.cs.dl.util.concurrent.misc

Class CVBuffer

Implemented Interfaces:
BoundedChannel, Channel, Puttable, Takable

public class CVBuffer
extends Object
implements BoundedChannel

Constructor Summary

CVBuffer()
CVBuffer(int cap)

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.
Object
take()
Return and remove an item from channel, possibly waiting indefinitely until such an item exists.

Constructor Details

CVBuffer

public CVBuffer()

CVBuffer

public CVBuffer(int cap)

Method Details

capacity

public int capacity()
Return the maximum number of elements that can be held.
Specified by:
capacity in interface BoundedChannel
Returns:
the capacity of this channel.

offer

public boolean offer(Object x,
                     long msecs)
            throws InterruptedException
Place item in channel only if it can be accepted within msecs milliseconds. The time bound is interpreted in a coarse-grained, best-effort fashion.
Specified by:
offer in interface Channel
offer in interface Puttable
Parameters:
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.
Returns:
true if accepted, else false

peek

public Object peek()
Return, but do not remove object at head of Channel, or null if it is empty.
Specified by:
peek in interface Channel

poll

public Object poll(long msecs)
            throws InterruptedException
Return and remove an item from channel only if one is available within msecs milliseconds. The time bound is interpreted in a coarse grained, best-effort fashion.
Specified by:
poll in interface Channel
poll in interface Takable
Parameters:
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.
Returns:
some item, or null if the channel is empty.

put

public void put(Object x)
            throws InterruptedException
Place item in the channel, possibly waiting indefinitely until it can be accepted. Channels implementing the BoundedChannel subinterface are generally guaranteed to block on puts upon reaching capacity, but other implementations may or may not block.
Specified by:
put in interface Channel
put in interface Puttable
Parameters:

take

public Object take()
            throws InterruptedException
Return and remove an item from channel, possibly waiting indefinitely until such an item exists.
Specified by:
take in interface Channel
take in interface Takable
Returns:
some item from the channel. Different implementations may guarantee various properties (such as FIFO) about that item