jcsp.lang
Class One2AnyChannel

java.lang.Object
  |
  +--jcsp.lang.One2AnyChannel

All Implemented Interfaces:

Channel, ChannelInput, ChannelOutput, Serializable

public class One2AnyChannel

extends Object

implements Channel, Serializable

This implements a one-to-any object channel, safe for use by one writer and many readers.

Description

One2AnyChannel is an implementation of a channel which is safe for use by many reading processes but only one writer. Reading processes compete with each other to use the channel. Only one reader and the writer will actually be using the channel at any one time. This is taken care of by One2AnyChannel -- user processes just read from or write to it.

Please note that this is a sefely shared channel and not a broadcaster. Currently, broadcasting has to be managed by writing active processes (see DynamicDelta for an example).

All reading processes and the writing process commit to the channel (i.e. may not back off). This means that the reading processes may not ALT on this channel.

The default semantics of the channel is that of CSP -- i.e. it is zero-buffered and fully synchronised. A reading process must wait for the matching writer and vice-versa.

However, the static create method allows the user to create a channel with a plug-in driver conforming to the ChannelDataStore interface. This allows a variety of different channel semantics to be introduced -- including buffered channels of user-defined capacity (including infinite), overwriting channels (with various overwriting policies) etc.. Standard examples are given in the jcsp.util package, but careful users may write their own.

Other static create methods allows the user to create fully initialised arrays of channels, including plug-ins if required.

Author:

P.D.Austin and P.H.Welch

See Also:

Alternative, One2OneChannel, Any2OneChannel, Any2AnyChannel, ChannelDataStore, Serialized Form

Constructor Summary

One2AnyChannel()
Constructs a new One2AnyChannel with a ZeroBuffer ChannelDataStore.

One2AnyChannel(ChannelDataStore data)
Deprecated. Use One2AnyChannel.create (ChannelDataStore).

Method Summary

static One2AnyChannel	create(ChannelDataStore store) Creates a One2AnyChannel using the specified ChannelDataStore.
static One2AnyChannel[]	create(int n) Creates an array of One2AnyChannels.
static One2AnyChannel[]	create(int n, ChannelDataStore store) Creates an array of One2AnyChannels using the specified ChannelDataStore.
Object	read() Reads an Object from the Channel.
void	write(Object value) Writes an Object to the Channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

One2AnyChannel

public One2AnyChannel()

Constructs a new One2AnyChannel with a ZeroBuffer ChannelDataStore.

One2AnyChannel

public One2AnyChannel(ChannelDataStore data)

Deprecated. Use One2AnyChannel.create (ChannelDataStore).

Constructs a new One2AnyChannel with the specified ChannelDataStore.

Parameters:

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

Method Detail

read

public Object 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

Returns:

the object read from the channel.

write

public void write(Object value)

Writes an Object to the Channel.

Specified by:

write in interface ChannelOutput

Parameters:

value - the object to write to the Channel.

create

public static One2AnyChannel[] create(int n)

Creates an array of One2AnyChannels.

Parameters:

n - the number of channels to create in the array

Returns:

the array of One2AnyChannels

create

public static One2AnyChannel create(ChannelDataStore store)

Creates a One2AnyChannel using the specified ChannelDataStore.

Returns:

the One2AnyChannel

create

public static One2AnyChannel[] create(int n,
                                      ChannelDataStore store)

Creates an array of One2AnyChannels using the specified ChannelDataStore.

Parameters:

n - the number of channels to create in the array

Returns:

the array of One2AnyChannels