com.revolsys.parallel.channel

Class Channel<T>

java.lang.Object

com.revolsys.parallel.channel.Channel<T>

All Implemented Interfaces:

ChannelInput<T>, ChannelOutput<T>, SelectableChannelInput<T>, SelectableInput, Iterable<T>

public class Channel<T>
extends Object
implements SelectableChannelInput<T>, ChannelOutput<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected MultiInputSelector	alt The Alternative class which will control the selection
protected ChannelValueStore<T>	data The ChannelValueStore used to store the data for the Channel
protected Object	monitor The monitor reads must synchronize on
protected Object	readMonitor The monitor reads must synchronize on
protected Object	writeMonitor The monitor writes must synchronize on

Fields inherited from interface com.revolsys.parallel.channel.SelectableInput

AVAILABLE, CLOSED, EMPTY

Constructor Summary

Constructors

Constructor and Description
Channel() Constructs a new Channel with a ZeroBuffer ChannelValueStore.
Channel(ChannelValueStore<T> data) Constructs a new Channel with the specified ChannelValueStore.
Channel(String name)
Channel(String name, ChannelValueStore<T> data)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
boolean	disable()
boolean	enable(MultiInputSelector alt)
String	getName()
boolean	isClosed()
Iterator<T>	iterator()
T	read() Reads an Object from the Channel.
T	read(long timeout) Reads an Object from the Channel.
void	readConnect()
void	readDisconnect()
String	toString()
void	write(T value) Writes an Object to the Channel.
void	writeConnect()
void	writeDisconnect()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

alt

protected MultiInputSelector alt

The Alternative class which will control the selection

data

protected ChannelValueStore<T> data

The ChannelValueStore used to store the data for the Channel

monitor

protected Object monitor

The monitor reads must synchronize on

readMonitor

protected Object readMonitor

The monitor reads must synchronize on

writeMonitor

protected Object writeMonitor

The monitor writes must synchronize on

Constructor Detail

Channel

public Channel()

Constructs a new Channel with a ZeroBuffer ChannelValueStore.

Channel

public Channel(ChannelValueStore<T> data)

Constructs a new Channel with the specified ChannelValueStore.

Parameters:

data - The ChannelValueStore used to store the data for the Channel

Channel

public Channel(String name)

Channel

public Channel(String name,
       ChannelValueStore<T> data)

Method Detail

close

public void close()

disable

public boolean disable()

Specified by:

disable in interface SelectableInput

enable

public boolean enable(MultiInputSelector alt)

Specified by:

enable in interface SelectableInput

getName

public String getName()

isClosed

public boolean isClosed()

Specified by:

isClosed in interface SelectableInput

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

read

public T read()

Reads an Object from the Channel. This method also ensures only one of the readers can actually be reading at any time. All other readers are blocked until it completes the read.

Specified by:

read in interface ChannelInput<T>

Returns:

The object returned from the Channel.

read

public T read(long timeout)

Reads an Object from the Channel. This method also ensures only one of the readers can actually be reading at any time. All other readers are blocked until it completes the read. If no data is available to be read after the timeout the method will return null.

Specified by:

read in interface ChannelInput<T>

Parameters:

timeout - The maximum time to wait in milliseconds.

Returns:

The object returned from the Channel.

readConnect

public void readConnect()

Specified by:

readConnect in interface ChannelInput<T>

readDisconnect

public void readDisconnect()

Specified by:

readDisconnect in interface ChannelInput<T>

toString

public String toString()

Overrides:

toString in class Object

write

public void write(T value)

Writes an Object to the Channel. This method also ensures only one of the writers can actually be writing at any time. All other writers are blocked until it completes the write.

Specified by:

write in interface ChannelOutput<T>

Parameters:

value - The object to write to the Channel.

writeConnect

public void writeConnect()

Specified by:

writeConnect in interface ChannelOutput<T>

writeDisconnect

public void writeDisconnect()

Specified by:

writeDisconnect in interface ChannelOutput<T>