org.jcsp.net2

Class Net2AnyChannel<T>

java.lang.Object

org.jcsp.net2.Net2AnyChannel<T>

All Implemented Interfaces:

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

final class Net2AnyChannel<T>
extends java.lang.Object
implements NetSharedChannelInput<T>

This class is a concrete implementation of a NetSharedChannelInput, and acts as a wrapper to a Net2OneChannel, allowing safe shared access. This class is internal to the JCSP architecture. To create an instance of this class, use the NetChannel factory, or the CNS.

See Also:

NetChannelInput, NetSharedChannelInput, NetChannel

Field Summary

Fields

Modifier and Type	Field and Description
private Net2OneChannel	actualChannel The underlying Net2OneChannel that this object wraps around
private Mutex	mutex A mutual exclusion lock, allowing only one process access to perform a read operation at a time

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Net2AnyChannel(Net2OneChannel chan) Constructor for Net2AnyChannel

Method Summary

Modifier and Type	Method and Description
(package private) static <T2> Net2AnyChannel<T2>	create(int index, int poisonImmunity, NetworkMessageFilter.FilterRx filter) Static factory method for creating a new instance of Net2AnyChannel, given a particular index
(package private) static <T2> Net2AnyChannel<T2>	create(int poisonImmunity, NetworkMessageFilter.FilterRx filter) A static factory method to create a new Net2AnyChannel object
void	destroy() Destroys the channel
void	endRead() Ends an extended read operation
NetLocation	getLocation() Gets the channel location of this 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() Begins an extended read operation on the channel

Methods inherited from class java.lang.Object

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

Field Detail

actualChannel

private final Net2OneChannel actualChannel

The underlying Net2OneChannel that this object wraps around

mutex

private final Mutex mutex

A mutual exclusion lock, allowing only one process access to perform a read operation at a time

Constructor Detail

Net2AnyChannel

private Net2AnyChannel(Net2OneChannel chan)

Constructor for Net2AnyChannel

Parameters:

chan - The underlying channel that this object will wrap around

Method Detail

create

static <T2> Net2AnyChannel<T2> create(int poisonImmunity,
                                      NetworkMessageFilter.FilterRx filter)
                               throws JCSPNetworkException

A static factory method to create a new Net2AnyChannel object

Parameters:

poisonImmunity - The immunity level of the channel

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

Returns:

A new Net2AnyChannel

Throws:

JCSPNetworkException - Thrown if there is a problem creating the underlying channel

create

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

Static factory method for creating a new instance of Net2AnyChannel, given a particular index

Parameters:

index - The index to create the channel with

poisonImmunity - the immunity level of the channels

filter - The filter used to convert the byte array back into an object

Returns:

A new Net2AnyChannel

Throws:

java.lang.IllegalArgumentException - Thrown if a channel with the given index already exists

JCSPNetworkException - Thrown if something goes wrong during the creation of the underlying channel

endRead

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

Ends an extended read operation

Specified by:

endRead in interface ChannelInput<T>

Throws:

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

JCSPNetworkException - Thrown if something goes wrong in the underlying network architecture

NetworkPoisonException - Thrown if the underlying channel has been poisoned

read

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

Reads the next message from the channel

Specified by:

read in interface ChannelInput<T>

Returns:

Message read from the channel

Throws:

JCSPNetworkException - Thrown if something goes wrong in the underlying architecture

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

NetworkPoisonException - Thrown if the channel has been poisoned

startRead

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

Begins an extended read operation on the channel

Specified by:

startRead in interface ChannelInput<T>

Returns:

The message read from the channel

Throws:

JCSPNetworkException - Thrown if something goes wrong in the underlying architecture

NetworkPoisonException - Thrown if the channel has been poisoned

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

poison

public void poison(int strength)

Poisons the underlying channel

Specified by:

poison in interface Poisonable

Parameters:

strength - The strength of the poison

getLocation

public NetLocation getLocation()

Gets the channel location of this channel

Specified by:

getLocation in interface Networked

Returns:

Location of this channel

destroy

public void destroy()

Destroys the channel

Specified by:

destroy in interface Networked

setDecoder

public void setDecoder(NetworkMessageFilter.FilterRx decoder)

Sets the underlying message filter

Specified by:

setDecoder in interface NetChannelInput<T>

Parameters:

decoder - The new message filter to use