diff --git a/README.txt b/README.txt index 8e9db4855296e9e3155f88a5616ca2206cb5aa85..4e667dbaca5d8e0d202831de8406d1dc5a6a15c1 100644 --- a/README.txt +++ b/README.txt @@ -1,4 +1,4 @@ -SMaRt v0.5 +SMaRt v0.6 ---------- This package contains the SMaRt source code (src/), binary file (bin/), libraries needed (lib/), documentation (doc/), and configuration files (config/). @@ -15,14 +15,32 @@ each replica. 2 localhost 11236 3 localhost 11237 -2.) The system configurations also have to be specified (see config/system.config). Most of the parameters are -self explanatory. +2.) The system configurations also have to be specified (see config/system.config). Most of the parameters are self explanatory. -You can run the counter demonstration by executing the script "runscripts/launch_CounterDemo.bat". This script can be easily adapted to run the other demos. Note that this script only runs in Windows, but it is easy to derive a shell script that runs in other operating systems. +You can run the counter demonstration by executing the following commands, from within the main folder: -Additionally to the counter demo, there is also the random demo. You can run it by launching the script "runscripts/launch_RandomDemo.bat". +#Start the servers (4 replicas, to tolerate 1 fault) +runscripts\smartrun.bat navigators.smart.tom.demo.counter.CounterServer 0 +runscripts\smartrun.bat navigators.smart.tom.demo.counter.CounterServer 1 +runscripts\smartrun.bat navigators.smart.tom.demo.counter.CounterServer 2 +runscripts\smartrun.bat navigators.smart.tom.demo.counter.CounterServer 3 -This version of SMaRt implements a state transfer protocol, which is still experimental. You can activate/de-activate it by editing the "config/system.config" file, and setting the parameter "system.totalordermulticast.state_transfer" to "false" +#Start a client + +#if equals 0 the request will be read-only +#default equals 1000 + +runscripts\smartrun.bat navigators.smart.tom.demo.counter.CounterClient 1001 [] + +You ca use the "runsmart.bat" script in Windows, and the "runsmart.sh" script em linux. These scripts can be easly be adaptated to run other demos, and you can derived other scripts from these ones to run SMaRt in other operating systems. + +Additionally to the counter demo, there is also the random demo. You can run it by using the RandomServer and RandomClient classes located in the package navigators.smart.tom.demo.random. + +This version of SMaRt implements a state transfer protocol, which is already pretty robust. You can activate/de-activate it by editing the "config/system.config" file, and setting the parameter "system.totalordermulticast.state_transfer" to "false". + +This version also implements a recofiguration protocol, that you can use to had/remove replicas from the initial group. This protocol is still experimental. + +Finally, we have also implemented a new version of the leader change protocol, which is also experimental. Feel free to contact us if you have any questions.