public class CNS extends Object implements CSProcess
This class is the Channel Name Server's main server process class.
This class should only be instantiated at Nodes wishing to run a server process. Although this class does not need to
be used by clients wishing to interact with a server, it does provide some convenient static methods for client code
to use. There are static versions of the methods provided in CNSService
and there are also static
factory methods for constructing CNS registered channel objects.
Channel Name Servers may be run either on a dedicated Node or else on the same Node as one of the user Nodes. The former approach is recommended for most situations but for smaller scale use, the latter approach may suffice.
The following example initialises a Node and installs a Channel Name Server. It then proceeds to install a CNS client service and creates and resolves a channel. The example does not proceed to do anything else but could be used as the framework for an application wishing to host its own Channel Name Server.
import org.jcsp.lang.*;
import org.jcsp.net2.*;
import org.jcsp.net2.cns.*;
import org.jcsp.net2.tcpip.*;
import java.io.IOException;
public class CNSInSameJVM implements CSProcess {
//main method for running example
public static void main(String[] args) {
CNSInSameJVM proc = new CNSInSameJVM();
proc.run();
}
public void run() {
NodeKey key = null;
NodeID localNodeID = null;
try {
//Initialize a Node that does not have a CNS client
key = Node.getInstance().init(new TCPIPNodeAddress(7890));
new ProcessManager(CNS.getInstance()).start();
//Dedicated server code could stop here
//Initialise the CNS client
//use the local NodeID to connect to the CNS
localNodeID = Node.getInstance().getNodeID();
CNS.init(localNodeID);
// creating Channel named "in"
NetChannelInput in = CNS.net2one("in");
//resolve the channel
NetChannelOutput out = CNS.one2net("in");
//could now use these channels for something!!
//but this is only a test so will terminate
} catch (NodeInitFailedException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
Node.log.log(this, "Done."); } }
In order to construct a ChannelInput
object which can be resolved by other users of a channel name
server, a client simply needs to to do this:
NetChannelInput in = CNS.net2one("Fred");
Another process using the same channel name server can create a ChannelOutput
that will send objects
to this channel by do this:
NetChannelOutput out = CNS.one2net("Fred");
When these factory methods are called, various resources are used within the JCSP infrastructure. A channel name will be registered and held in the channel name server. These resources are taken for the duration of the JCSP Node's runtime.
This is an example "Hello World" program which contains two inner classes with main methods, each of which can be run in separate JVMs.
import org.jcsp.lang.*; import org.jcsp.net2.*; import org.jcsp.net2.cns.*; public class TestCNS { public static class Rx { public static void main(String[] args) { try { Node.getInstance().init(new TCPIPNodeAddress(7890)); NetChannelInput in = CNS.net2one("rx.in"); System.out.println(in.read()); } catch (Exception e) { e.printStackTrace(); } } } public static class Tx { public static void main(String[] args) { try { Node.getInstance().init(new TCPIPNodeAddress(7890)); NetChannelOutput out = CNS.one2net("rx.in"); out.write("Hello World"); } catch (Exception e) { e.printStackTrace(); } } } }
This code can be compiled and then the following run at two command prompts:
java TestCNS$Rx
java TestCNS$Tx
The programs will connect to a default channel name server. The Rx program will create a NetChannelInput
and wait for a message on the channel. Once it has received the message, it prints it, then terminates. The Tx
program creates a NetChannelOutput
that will send to the Rx program's input channel. It sends a "Hello
World" message. Once this has been accepted by the Rx process, it terminates.
CNSService
,
Node
Modifier and Type | Method and Description |
---|---|
static <T> NetSharedChannelOutput<T> |
any2net(String name)
Creates a new NetSharedChannelOutput connected to the input channel registered with the given name
|
static <T> NetSharedChannelOutput<T> |
any2net(String name,
int immunityLevel)
Creates a new NetSharedChannelOutput connected to the input channel registered with the given name
|
static <T> NetSharedChannelOutput<T> |
any2net(String name,
int immunityLevel,
NetworkMessageFilter.FilterTx filter)
Creates a new NetSharedChannelOutput connected to the input channel registered with the given name
|
static <T> NetSharedChannelOutput<T> |
any2net(String name,
NetworkMessageFilter.FilterTx filter)
Creates a new NetSharedChannelOutput connected to the input channel registered with the given name
|
static NetSharedChannelOutput |
createAny2Net(String name)
Deprecated.
Use one2net instead
|
static NetSharedChannelInput |
createNet2Any(String name)
Deprecated.
Use net2any instead
|
static NetAltingChannelInput |
createNet2One(String name)
Deprecated.
Use net2one instead
|
static NetChannelOutput |
createOne2Net(String name)
Deprecated.
Use one2net instead
|
static CNS |
getInstance()
Gets the singleton instance of the CNS
|
static void |
initialise(NodeAddress cnsNode)
Initialises the factory methods to allow creation of channels with the CNS
|
static void |
initialise(NodeID cnsNode)
Initialises the factory methods to allow creation of channels with the CNS
|
static <T> NetSharedChannelInput<T> |
net2any(String name)
Creates a new NetSharedChannelInput registered with the given name
|
static <T> NetSharedChannelInput<T> |
net2any(String name,
int immunityLevel)
Creates a new NetSharedChannelInput registered with the given name
|
static <T> NetSharedChannelInput<T> |
net2any(String name,
int immunityLevel,
NetworkMessageFilter.FilterRx filter)
Creates a new NetSharedChannelInput registered with the given name
|
static <T> NetSharedChannelInput<T> |
net2any(String name,
NetworkMessageFilter.FilterRx filter)
Creates a new NetSharedChannelInput registered with the given name
|
static <T> NetAltingChannelInput<T> |
net2one(String name)
Creates a new NetAltingChannelInput registered with the given name
|
static <T> NetAltingChannelInput<T> |
net2one(String name,
int immunityLevel)
Creates a new NetAltingChannelInput registered with the given name
|
static <T> NetAltingChannelInput<T> |
net2one(String name,
int immunityLevel,
NetworkMessageFilter.FilterRx filter)
Creates a new NetAltingChannelInput registered with the given name
|
static <T> NetAltingChannelInput<T> |
net2one(String name,
NetworkMessageFilter.FilterRx filter)
Creates a new NetAltingChannelInput registered with the given name
|
static <T> NetSharedChannelInput<T> |
numberedNet2Any(String name,
int index)
Creates a new NetSharedChannelInput registered with the given name
|
static <T> NetSharedChannelInput<T> |
numberedNet2Any(String name,
int index,
int immunityLevel)
Creates a new NetSharedChannelInput registered with the given name
|
static <T> NetSharedChannelInput<T> |
numberedNet2Any(String name,
int index,
int immunityLevel,
NetworkMessageFilter.FilterRx filter)
Creates a new NetSharedChannelInput registered with the given name
|
static <T> NetSharedChannelInput<T> |
numberedNet2Any(String name,
int index,
NetworkMessageFilter.FilterRx filter)
Creates a new NetSharedChannelInput registered with the given name
|
static <T> NetAltingChannelInput<T> |
numberedNet2One(String name,
int index)
Creates a new NetAltingChannelInput registered with the given name
|
static <T> NetAltingChannelInput<T> |
numberedNet2One(String name,
int index,
int immunityLevel)
Creates a new NetAltingChannelInput registered with the given name
|
static <T> NetAltingChannelInput<T> |
numberedNet2One(String name,
int index,
int immunityLevel,
NetworkMessageFilter.FilterRx filter)
Creates a new NetAltingChannelInput registered with the given name
|
static <T> NetAltingChannelInput<T> |
numberedNet2One(String name,
int index,
NetworkMessageFilter.FilterRx filter)
Creates a new NetAltingChannelInput registered with the given name
|
static <T> NetChannelOutput<T> |
one2net(String name)
Creates a new NetChannelOutput connected to the input channel registered with the given name
|
static <T> NetChannelOutput<T> |
one2net(String name,
int immunityLevel)
Creates a new NetChannelOutput connected to the input channel registered with the given name
|
static <T> NetChannelOutput<T> |
one2net(String name,
int immunityLevel,
NetworkMessageFilter.FilterTx filter)
Creates a new NetChannelOutput connected to the input channel registered with the given name
|
static <T> NetChannelOutput<T> |
one2net(String name,
NetworkMessageFilter.FilterTx filter)
Creates a new NetChannelOutput connected to the input channel registered with the given name
|
void |
run()
The run method for the CNS process
|
public static CNS getInstance()
public static void initialise(NodeID cnsNode) throws JCSPNetworkException
cnsNode
- The Node that the CNS is located onJCSPNetworkException
- Thrown if something goes wrong in the underlying architecturepublic static void initialise(NodeAddress cnsNode) throws JCSPNetworkException
cnsNode
- The Node that the CNS is located onJCSPNetworkException
- Thrown if something goes wrong in the underlying architecturepublic static NetAltingChannelInput createNet2One(String name) throws IllegalStateException, IllegalArgumentException
name
- The name to register with the CNSIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static NetSharedChannelInput createNet2Any(String name) throws IllegalStateException, IllegalArgumentException
name
- The name to register with the CNSIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static NetChannelOutput createOne2Net(String name) throws IllegalStateException, JCSPNetworkException
name
- The name to resolveIllegalStateException
- Thrown if the connection to the CNS is not initialisedJCSPNetworkException
- Thrown if something goes wrong in the underlying architecturepublic static NetSharedChannelOutput createAny2Net(String name) throws JCSPNetworkException, IllegalStateException
name
- The name to resolveIllegalStateException
- Thrown if the connection to the CNS is not initialisedJCSPNetworkException
- Thrown if something goes wrong in the underlying architecturepublic static <T> NetAltingChannelInput<T> net2one(String name) throws IllegalStateException, IllegalArgumentException
name
- The name to register with the CNSIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetAltingChannelInput<T> net2one(String name, int immunityLevel) throws IllegalArgumentException, IllegalStateException
name
- The name to register with the CNSimmunityLevel
- The immunity to poison the channel hasIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetAltingChannelInput<T> net2one(String name, NetworkMessageFilter.FilterRx filter) throws IllegalArgumentException, IllegalStateException
name
- The name to register with the CNSfilter
- The filter used to decode incoming messagesIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetAltingChannelInput<T> net2one(String name, int immunityLevel, NetworkMessageFilter.FilterRx filter) throws IllegalArgumentException, IllegalStateException
name
- The name to register with the CNSimmunityLevel
- The immunity level to poison that the channel hasfilter
- The filter used to decode incoming messagesIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetSharedChannelInput<T> net2any(String name) throws IllegalArgumentException, IllegalStateException
name
- The name to register with the CNSIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetSharedChannelInput<T> net2any(String name, int immunityLevel) throws IllegalArgumentException, IllegalStateException
name
- The name to register with the CNSimmunityLevel
- The immunity level to poison that the channel hasIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetSharedChannelInput<T> net2any(String name, NetworkMessageFilter.FilterRx filter) throws IllegalArgumentException, IllegalStateException
name
- The name to register with the CNSfilter
- The filter used to decode incoming messagesIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetSharedChannelInput<T> net2any(String name, int immunityLevel, NetworkMessageFilter.FilterRx filter) throws IllegalArgumentException, IllegalStateException
name
- The name to register with the CNSimmunityLevel
- The immunity to poison that this channel hasfilter
- The filter used to decode incoming messagesIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetAltingChannelInput<T> numberedNet2One(String name, int index) throws IllegalStateException, IllegalArgumentException
name
- The name to register with the CNSindex
- The index to create the channel withIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetAltingChannelInput<T> numberedNet2One(String name, int index, int immunityLevel) throws IllegalStateException, IllegalArgumentException
name
- The name to register with the CNSindex
- The index to create the channel withimmunityLevel
- The immunity level to poison that the channel hasIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetAltingChannelInput<T> numberedNet2One(String name, int index, NetworkMessageFilter.FilterRx filter) throws IllegalStateException, IllegalArgumentException
name
- The name to register with the CNSindex
- The index to create the channel withfilter
- The filter used to decode incoming messagesIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetAltingChannelInput<T> numberedNet2One(String name, int index, int immunityLevel, NetworkMessageFilter.FilterRx filter) throws IllegalStateException, IllegalArgumentException
name
- The name to register with the CNSindex
- The index to create the channel withimmunityLevel
- The immunity level to poison that the channel hasfilter
- The filter used to decode incoming messagesIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetSharedChannelInput<T> numberedNet2Any(String name, int index) throws IllegalStateException, IllegalArgumentException
name
- The name to register with the CNSindex
- The index to create the channel withIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetSharedChannelInput<T> numberedNet2Any(String name, int index, int immunityLevel) throws IllegalStateException, IllegalArgumentException
name
- The name to register with the CNSindex
- The index to create the channel withimmunityLevel
- The immunity to poison that this channel hasIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetSharedChannelInput<T> numberedNet2Any(String name, int index, NetworkMessageFilter.FilterRx filter) throws IllegalStateException, IllegalArgumentException
name
- The name to register with the CNSindex
- The index to create the channel withfilter
- The filter used to decode incoming messagesIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetSharedChannelInput<T> numberedNet2Any(String name, int index, int immunityLevel, NetworkMessageFilter.FilterRx filter) throws IllegalStateException, IllegalArgumentException
name
- The name to register with the CNSindex
- The index to create the channel withimmunityLevel
- The immunity to poison that this channel hasfilter
- The filter used to decode incoming messagesIllegalStateException
- Thrown if the CNS has not been initialisedIllegalArgumentException
- Thrown if the channel name is already registeredpublic static <T> NetChannelOutput<T> one2net(String name) throws IllegalStateException, JCSPNetworkException
name
- The name to resolveIllegalStateException
- Thrown if the connection to the CNS is not initialisedJCSPNetworkException
- Thrown if something goes wrong in the underlying architecturepublic static <T> NetChannelOutput<T> one2net(String name, int immunityLevel) throws IllegalStateException, JCSPNetworkException
name
- The name to resolveimmunityLevel
- The immunity to poison that this channel hasIllegalStateException
- Thrown if the connection to the CNS is not initialisedJCSPNetworkException
- Thrown if something goes wrong in the underlying architecturepublic static <T> NetChannelOutput<T> one2net(String name, NetworkMessageFilter.FilterTx filter) throws IllegalStateException, JCSPNetworkException
name
- The name to resolvefilter
- The filter used to encode outgoing messagesIllegalStateException
- Thrown if the connection to the CNS is not initialisedJCSPNetworkException
- Thrown if something goes wrong in the underlying architecturepublic static <T> NetChannelOutput<T> one2net(String name, int immunityLevel, NetworkMessageFilter.FilterTx filter) throws IllegalStateException, JCSPNetworkException
name
- The name to resolveimmunityLevel
- The immunity to poison that this channel hasfilter
- The filter used to encode outgoing messagesIllegalStateException
- Thrown if the connection to the CNS is not initialisedJCSPNetworkException
- Thrown if something goes wrong in the underlying architecturepublic static <T> NetSharedChannelOutput<T> any2net(String name) throws IllegalStateException, JCSPNetworkException
name
- The name to resolveIllegalStateException
- Thrown if the connection to the CNS is not initialisedJCSPNetworkException
- Thrown if something goes wrong in the underlying architecturepublic static <T> NetSharedChannelOutput<T> any2net(String name, int immunityLevel) throws IllegalStateException, JCSPNetworkException
name
- The name to resolveimmunityLevel
- The immunity to poison that this channel hasIllegalStateException
- Thrown if the connection to the CNS is not initialisedJCSPNetworkException
- Thrown if something goes wrong in the underlying architecturepublic static <T> NetSharedChannelOutput<T> any2net(String name, NetworkMessageFilter.FilterTx filter) throws IllegalStateException, JCSPNetworkException
name
- The name to resolvefilter
- The filter used to encode outgoing messagesIllegalStateException
- Thrown if the connection to the CNS is not initialisedJCSPNetworkException
- Thrown if something goes wrong in the underlying architecturepublic static <T> NetSharedChannelOutput<T> any2net(String name, int immunityLevel, NetworkMessageFilter.FilterTx filter) throws IllegalStateException, JCSPNetworkException
name
- The name to resolveimmunityLevel
- The immunity level to poison that this channel hasfilter
- The filter used to encode outgoing messagesIllegalStateException
- Thrown if the connection to the CNS is not initialisedJCSPNetworkException
- Thrown if something goes wrong in the underlying architectureCopyright © 1996–2016. All rights reserved.