|
Colt 1.0.2 | |||||||||
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.SynchronousChannel
[ Introduction to this package. ]
A rendezvous channel, similar to those used in CSP and Ada. Each put must wait for a take, and vice versa.
Synchronous channels are well suited for handoff designs, in which an object running in one thread must synch up with an object running in another thread in order to hand it some information, event, or task. This implementation uses WaiterPreferenceSemaphores to help avoid infinite overtaking among multiple threads trying to perform puts or takes.
If you only need threads to synch up without exchanging information, consider using a Barrier. If you need bidirectional exchanges, consider using a Rendezvous.
For a usage example, see the implementation of PooledExecutor
[ Introduction to this package. ]
CyclicBarrier
,
Rendezvous
,
PooledExecutor
Constructor Summary | |
SynchronousChannel()
Create a new channel. |
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. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SynchronousChannel()
Method Detail |
public int capacity()
BoundedChannel
capacity
in interface 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 null 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 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.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |