Package org.jcsp.net

This is main package for JCSP.NET.

Before any JCSP.NET constructs can be used, the JCSP Node must be initialized. See the Node class for more information.

Networked channels can be constructed using the NetChannelEnd class or by using StandardNetChannelEndFactory.

See the org.jcsp.net.cns package for information on using named channels.

Interface Summary

Interface	Description
NetBufferedChannelEndFactory	This interface defines methods for constructing buffered Networked ChannelInput objects.
NetChannelEndFactory	This interface defines methods for constructing Networked channel ends.
NetChannelInput	An interface implemented by classes wishing to be Networked ChannelInput objects.
NetChannelOutput	An interface that should be implemented by ChannelOutput objects which are used for transmitting over the network.
NetConnectionClient	This interface should be implemented by classes that wish to act as Networked ConnectionClient objects.
NetConnectionFactory	This class should be implemented by classes wishing to act as factories for creating Networked ConnectionServer and ConnectionClient objects.
NetConnectionServer	This interface should be implemented by classes that wish to act as Networked ConnectionServer objects.
NetLabelledBufferedChannelEndFactory	This factory constructs buffered NetChannelInput objects which have labelled VCN's.
NetLabelledChannelEndFactory	This factory constructs NetChannelInput objects which have labelled VCN's.
NetSharedChannelInput	This interface should be implemented by classes that wish to act as NetChannelInput objects which can be used by muliple concurrent processes.
NetSharedChannelOutput	This interface should be implemented by classes that wish to act as NetChannelOutput objects which can be used by muliple concurrent processes.
NetSharedConnectionClient	This interface should be implemented by classes that wish to act as SharedConnectionClient objects which accept connections from ConnectionClient objects from over a JCSP.NET network.
NetSharedConnectionServer	Instances of classed implementing this method are SharedConnectionServer objects which accept connections from clients from over a JCSP.NET network.
Networked	An interface that should be implemented by any class that has a Networked channel location or wishes to expose the location of an underlying channel.
Node.Attributes	An interface for exposing access to the private attributes.
NodeFactory	Node initialisation factory interface.
Service	An interface that should be implemented by classes that are intended to be Node level JCSP.NET services.
ServiceUserObject	An Interface which does not define any methods but is used as a way of indicating that a class is used for accessing non-admin functionality provided by a service.

Class Summary

Class	Description
AbstractID	This is an abstract class that is sub-classed by classes whose instances should represent some kind of identifier and be part of a hierarchy of AbstractID objects.
ApplicationID	A Class whose instances represent a unique identifier for a JCSP.NET application.
DomainID	A Class whose instances represent a unique identifier for a JCSP.NET domain.
GlobalID	A Class whose instances represent the global domain.
Link	This class is an abstract class that all JCSP.NET protocol implementations must implement.
LinkFactory	This class does not need to be used by normal JCSP users.
LinkFactory.Builder	An abstract inner class which should be implemented by comunication protocol implementations.
LinkLost	Message warning that a Link broke.
LinkServer	An abstract class that must be implemented by communication protocol implementations.
Logger	Manages the output of diagnostic messages to one or more devices.
NetAltingChannelInput	An abstract class that is sub-classed by classes whose instances should be networked channel ends that can be used as an AltingChannelInput objects.
NetAltingConnectionClient	Instances of this class are AltingConnectionClient objects which connect to ConnectionServer objects over a JCSP.NET network.
NetChannelEnd	This class provides static factory methods for constructing Networked channel ends.
NetChannelLocation	Instances of this class hold location information for a networked ChannelInput object.
NetConnection	This class provides static methods for constructing NetConnectionServer and NetConnectionClient objects.
NetSharedAltingConnectionClient	Defines a class whose instances should be SharedAltingConnectionClient that connect to a ConnectionServer over a JCSP.NET network.
Node	This class that is used for initializing and managing the local JCSP.NET Node.
NodeAddressID	JCSP.NET communication protocol implementations must provide a concrete implementation of this class.
NodeID	A Class whose instances represent a unique identifier for a JCSP.NET Node.
NodeKey	An object that is returned when the Node is initialized.
NodeUI	A Unique Identifier for a Node.
NodeUIImpl	This is a default implementation for NodeUI that is used if no other implementation is supplied.
Profile	This class is used to hold profiles of Nodes and Links.
ProtocolID	Abstract class that identifies a protocol.
ProtocolManager	The ProtocolManager class is a singleton class.
ServiceManager	An instance of the ServiceManager is created by the Node when it is initialized.
ServiceSettings	This class is used to hold settings that can be passed to services when they are initialized.
StandardNetChannelEndFactory	A standard implementation of the JCSP.NET Networked channel factory interaces.
StandardNetConnectionFactory	This is an implementation of NetConnectionFactory.
UIFactory	This class is a Factory that construct a unique identify for this Node.
UnacknowledgedNetChannelEndFactory	Extends the standard network channel factory to give unacknowledged channel output ends.
Utils	This class provides some utility methods that developers might find useful when implementing JCSP.NET communication protocol drivers.
XMLNodeFactory	Factory for node instantiation based on an XML-like file.

Exception Summary

Exception	Description
DuplicateChannelLabelException	This Exception is thrown if there is an attempt to label a channel's VCN with a label that already exists at the same Node.
LinkLostException	An exception caused by a link underlying a channel breaking.
NodeInitFailedException	An Exception that is thrown if Node initialization fails.
ReaderIndexException	An exception that is thrown if data is written to a Networked ChannelOutput and the destination address is incorrect.
ServiceInstallationException	An excpetion that is thrown if a service installation fails.

Error Summary

Error	Description
NetChannelError	This is an error that is thrown by a Networked channel if something happens that should never happen.