org.jcsp.net2

Class Net2OneChannel<T>

java.lang.Object

org.jcsp.lang.Guard

org.jcsp.lang.AltingChannelInput<T>

org.jcsp.lang.AltingChannelInputWrapper<T>

org.jcsp.net2.NetAltingChannelInput<T>

org.jcsp.net2.Net2OneChannel<T>

All Implemented Interfaces:

ChannelInput<T>, Poisonable, NetChannelInput<T>, Networked

final class Net2OneChannel<T>
extends NetAltingChannelInput<T>

A concrete implementation of a NetAltingChannelInput. This is a hidden class created by the architecture. To create an instance of this object, use the NetChannel factory, or the CNS.

See Also:

NetChannelInput, NetAltingChannelInput, NetChannel

Field Summary

Fields

Modifier and Type	Field and Description
private ChannelData	data The ChannelData structure representing this channel.
private AltingChannelInput	in The input channel coming into the networked channel input object from Links or locally connected net channel outputs.
private NetworkMessage	lastRead The lastRead ChannelMessage.
private NetChannelLocation	location The location of this channel
private NetworkMessageFilter.FilterRx	messageFilter The filter used to convert the incoming byte array into an object

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Net2OneChannel(AltingChannelInput input, ChannelData chanData, NetworkMessageFilter.FilterRx filter) Private constructor for creating a new instance of a Net2OneChannel.

Method Summary

Modifier and Type	Method and Description
(package private) static <T2> Net2OneChannel<T2>	create(int index, int poisonImmunity, NetworkMessageFilter.FilterRx filter) Static factory method used to create a new Net2OneChannel with a given index.
(package private) static <T2> Net2OneChannel<T2>	create(int poisonImmunity, NetworkMessageFilter.FilterRx filter) Static factory method used to create a new Net2OneChannel.
void	destroy() Destroys the underlying channel
void	endRead() Ends an extended read operation.
(package private) ChannelData	getChannelData() Gets the channel data object for this channel.
NetLocation	getLocation() Returns the NetChannelLocation of the channel
boolean	pending() Checks if any data is waiting on the channel.
void	poison(int strength) Poisons the underlying channel
T	read() Reads the next message from the channel
void	setDecoder(NetworkMessageFilter.FilterRx decoder) Sets the underlying message filter
T	startRead() Performs an extended read operation on the channel

Methods inherited from class org.jcsp.lang.AltingChannelInputWrapper

getChannel, setChannel

Methods inherited from class org.jcsp.lang.Guard

schedule

Methods inherited from class java.lang.Object

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

Field Detail

in

private final AltingChannelInput in

The input channel coming into the networked channel input object from Links or locally connected net channel outputs.

data

private final ChannelData data

The ChannelData structure representing this channel.

lastRead

private NetworkMessage lastRead

The lastRead ChannelMessage. Used during an extended read operation to allow the ACK message to be sent to the correct Node.

messageFilter

private NetworkMessageFilter.FilterRx messageFilter

The filter used to convert the incoming byte array into an object

location

private final NetChannelLocation location

The location of this channel

Constructor Detail

Net2OneChannel

private Net2OneChannel(AltingChannelInput input,
                       ChannelData chanData,
                       NetworkMessageFilter.FilterRx filter)
                throws JCSPNetworkException

Private constructor for creating a new instance of a Net2OneChannel. This is called by the create method to create the channel.

Parameters:

input - The input channel connecting to the networked channel.

chanData - The ChannelData object representing the networked channel.

filter - The filter used to convert the incoming byte array to an object

Throws:

JCSPNetworkException

Method Detail

create

static <T2> Net2OneChannel<T2> create(int poisonImmunity,
                                      NetworkMessageFilter.FilterRx filter)

Static factory method used to create a new Net2OneChannel. Used internally within the architecture.

Parameters:

poisonImmunity - The immunity level of the channel

filter - The filter on the channel used to convert read bytes into an object

Returns:

A new Net2OneChannel

create

static <T2> Net2OneChannel<T2> create(int index,
                                      int poisonImmunity,
                                      NetworkMessageFilter.FilterRx filter)
                               throws java.lang.IllegalArgumentException

Static factory method used to create a new Net2OneChannel with a given index. Used internally within the architecture

Parameters:

index - The index to create the channel with

poisonImmunity - The immunity level of the channel

filter - The filter used to take the incoming byte array and convert it into an object

Returns:

A new Net2OneChannel

Throws:

java.lang.IllegalArgumentException - Thrown if the index given is already allocated within the ChannelManager

endRead

public void endRead()
             throws java.lang.IllegalStateException,
                    JCSPNetworkException,
                    NetworkPoisonException

Ends an extended read operation.

Specified by:

endRead in interface ChannelInput<T>

Overrides:

endRead in class AltingChannelInputWrapper<T>

Throws:

java.lang.IllegalStateException - Thrown if the method is called when the channel is not in an extended read state

JCSPNetworkException - Thrown if something goes wrong in the underlying architecture

NetworkPoisonException - Thrown if the channel has been poisoned

See Also:

ChannelInput.endRead

pending

public boolean pending()
                throws JCSPNetworkException,
                       NetworkPoisonException

Checks if any data is waiting on the channel.

Overrides:

pending in class AltingChannelInputWrapper<T>

Returns:

True if data is ready, false otherwise.

Throws:

JCSPNetworkException - Thrown if the channel has been destroyed

NetworkPoisonException - Thrown if the channel has poisoned

poison

public void poison(int strength)

Poisons the underlying channel

Specified by:

poison in interface Poisonable

Overrides:

poison in class AltingChannelInputWrapper<T>

Parameters:

strength - The strength of the poison

read

public T read()
       throws JCSPNetworkException,
              NetworkPoisonException,
              java.lang.IllegalStateException

Reads the next message from the channel

Specified by:

read in interface ChannelInput<T>

Overrides:

read in class AltingChannelInputWrapper<T>

Returns:

The message read from the channel

Throws:

JCSPNetworkException - Thrown if something goes wrong in the underlying architecture

NetworkPoisonException - Thrown if the channel is poisoned

java.lang.IllegalStateException - Thrown if the channel is in an extended read state

startRead

public T startRead()
            throws JCSPNetworkException,
                   java.lang.IllegalStateException,
                   NetworkPoisonException

Performs an extended read operation on the channel

Specified by:

startRead in interface ChannelInput<T>

Overrides:

startRead in class AltingChannelInputWrapper<T>

Returns:

The message read from the channel

Throws:

JCSPNetworkException - Thrown if something goes wrong in the underlying architecture

java.lang.IllegalStateException - Thrown if the channel is already in an extended read state

NetworkPoisonException - Thrown if the channel is poisoned.

See Also:

ChannelInput.startRead

getLocation

public NetLocation getLocation()

Returns the NetChannelLocation of the channel

Returns:

Location of this channel

destroy

public void destroy()

Destroys the underlying channel

getChannelData

final ChannelData getChannelData()

Gets the channel data object for this channel.

Returns:

The ChannelData for this Channel

setDecoder

public void setDecoder(NetworkMessageFilter.FilterRx decoder)

Sets the underlying message filter

Parameters:

decoder - The message filter to use