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

Class FIFOSlot

Implemented Interfaces:
BoundedChannel, Channel, Puttable, Takable

public class FIFOSlot
extends Object
implements BoundedChannel

Constructor Summary

FIFOSlot()

Method Summary

int
capacity()
boolean
offer(Object item, 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 item)
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

FIFOSlot

public FIFOSlot()

Method Details

capacity

public int capacity()
Specified by:
capacity in interface BoundedChannel


offer

public boolean offer(Object item,
                     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:
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.

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 item)
            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:
item - the element to be inserted. Should be non-null.


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