CSP for Java
(JCSP) 1.0-rc4

jcsp.lang
Class One2AnyChannelInt

java.lang.Object
  |
  +--jcsp.lang.One2AnyChannelInt
All Implemented Interfaces:
ChannelInputInt, ChannelInt, ChannelOutputInt, Serializable

public class One2AnyChannelInt
extends Object
implements ChannelInt, Serializable

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

Description

One2AnyChannelInt is an implementation of an integer 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 One2AnyChannelInt -- user processes just read from or write to it.

Please note that this is a safely shared channel and not a broadcaster. Currently, broadcasting has to be managed by writing active processes (see DynamicDeltaInt 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 ChannelDataStoreInt 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, One2OneChannelInt, Any2OneChannelInt, Any2AnyChannelInt, ChannelDataStoreInt, Serialized Form

Constructor Summary
One2AnyChannelInt()
          Constructs a new One2AnyChannelInt with a ZeroBufferInt ChannelDataStoreInt.
One2AnyChannelInt(ChannelDataStoreInt data)
          Deprecated. Use One2AnyChannelInt.create (ChannelDataStoreInt).
 
Method Summary
static One2AnyChannelInt create(ChannelDataStoreInt store)
          Creates a One2AnyChannelInt using the specified ChannelDataStoreInt.
static One2AnyChannelInt[] create(int n)
          Creates an array of One2AnyChannelInts.
static One2AnyChannelInt[] create(int n, ChannelDataStoreInt store)
          Creates an array of One2AnyChannelInts using the specified ChannelDataStoreInt.
 int read()
          Reads an int from the channel.
 void write(int value)
          Writes an int to the channel.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

One2AnyChannelInt

public One2AnyChannelInt()
Constructs a new One2AnyChannelInt with a ZeroBufferInt ChannelDataStoreInt.

One2AnyChannelInt

public One2AnyChannelInt(ChannelDataStoreInt data)
Deprecated. Use One2AnyChannelInt.create (ChannelDataStoreInt).

Constructs a new One2AnyChannelInt with the specified ChannelDataStoreInt.
Parameters:
data - The ChannelDataStoreInt used to store the data for the Channel
Method Detail

read

public int read()
Reads an int 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 ChannelInputInt
Returns:
the integer read from the channel.

write

public void write(int value)
Writes an int to the channel.
Specified by:
write in interface ChannelOutputInt
Parameters:
value - the integer to write to the channel.

create

public static One2AnyChannelInt[] create(int n)
Creates an array of One2AnyChannelInts.
Parameters:
n - the number of channels to create in the array
Returns:
the array of One2AnyChannelInts

create

public static One2AnyChannelInt create(ChannelDataStoreInt store)
Creates a One2AnyChannelInt using the specified ChannelDataStoreInt.
Returns:
the One2AnyChannelInt

create

public static One2AnyChannelInt[] create(int n,
                                         ChannelDataStoreInt store)
Creates an array of One2AnyChannelInts using the specified ChannelDataStoreInt.
Parameters:
n - the number of channels to create in the array
Returns:
the array of One2AnyChannelInts

CSP for Java
(JCSP) 1.0-rc4

Submit a bug or feature to jcsp-team@ukc.ac.uk
Version 1.0-rc4 of the JCSP API Specification (Copyright 1997-2000 P.D.Austin and P.H.Welch - All Rights Reserved)
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.