| 1 | PlanetSim |
|---|
| 2 | --------------- |
|---|
| 3 | @author Jordi Pujol jordi.pujol@estudiants.urv.es |
|---|
| 4 | http://ants.etse.urv.es/planetsim |
|---|
| 5 | |
|---|
| 6 | 1. Presentation |
|---|
| 7 | ---------------------- |
|---|
| 8 | |
|---|
| 9 | This is the release PlanetSim 3.0. Its use and modification is under |
|---|
| 10 | LGPL Licence. |
|---|
| 11 | |
|---|
| 12 | The PlanetSim is an overlay simulator. Exists a clear separation of |
|---|
| 13 | the three different layers that are simulated: |
|---|
| 14 | |
|---|
| 15 | 1. Network level. Mantain the communication between all nodes in |
|---|
| 16 | the network. |
|---|
| 17 | |
|---|
| 18 | 2. Node level: Implements each desired overlay, consisting in |
|---|
| 19 | its routing table and the application suppport ability. |
|---|
| 20 | |
|---|
| 21 | 3. Application level: Implements the desired (one or more per node) |
|---|
| 22 | using the underlying node to contact with other applications. |
|---|
| 23 | Each implemented application has an objective, implements |
|---|
| 24 | a DHT (Distributed Hash Table), for example. |
|---|
| 25 | |
|---|
| 26 | |
|---|
| 27 | 2. Content |
|---|
| 28 | ---------------------- |
|---|
| 29 | |
|---|
| 30 | These distribution is a Java Eclipse project (http://eclipse.org). |
|---|
| 31 | One may use the "Import... -> Existing Project into Workspace" |
|---|
| 32 | functionallity and browsing to this uncompressed directory to load |
|---|
| 33 | the PlanetSim to your Eclipse. |
|---|
| 34 | |
|---|
| 35 | Elsewhere, you may edit any class and add the required classes |
|---|
| 36 | and packages with any other IDE or editor. Then, you can use |
|---|
| 37 | the ant project manager to compile and build the distribution |
|---|
| 38 | planetsim.jar file automatically. See bin/README file for |
|---|
| 39 | more details. |
|---|
| 40 | |
|---|
| 41 | Directory description: |
|---|
| 42 | |
|---|
| 43 | bin |
|---|
| 44 | Contain all required scripts and source data file to run the |
|---|
| 45 | existing tests. Also contains the build.xml and |
|---|
| 46 | planetsim.properties files to use Ant. |
|---|
| 47 | See bin/README for more details. |
|---|
| 48 | |
|---|
| 49 | docs |
|---|
| 50 | Contain a brief introduction to the PlanetSim Architecture |
|---|
| 51 | in HTML format. Also contain the HTML Javadoc API of the |
|---|
| 52 | entire PlanetSim. |
|---|
| 53 | |
|---|
| 54 | lib |
|---|
| 55 | Contain the required jars to compile and run all tests. |
|---|
| 56 | |
|---|
| 57 | src |
|---|
| 58 | Contain the Java source classes of the PlanetSim. |
|---|
| 59 | |
|---|
| 60 | out |
|---|
| 61 | Contain the Java bytecode classes of the PlanetSim. |
|---|
| 62 | Initially empty. |
|---|
| 63 | |
|---|
| 64 | conf |
|---|
| 65 | Contain the configuration files to run all the tests. |
|---|
| 66 | |
|---|
| 67 | |
|---|
| 68 | 3. Feedback |
|---|
| 69 | ----------------------- |
|---|
| 70 | |
|---|
| 71 | You can make a very good feedback send us your suggestions, |
|---|
| 72 | implemented extensions, fixed bugs or the errors. |
|---|
| 73 | Send an email to Jordi Pujol <jordi.pujol@estudiants.urv.es> |
|---|
| 74 | |
|---|
| 75 | On any error or problem cases, you have to send these information: |
|---|
| 76 | |
|---|
| 77 | 1. Version of Planetsim in use |
|---|
| 78 | 2. Short description of the error (or problem) |
|---|
| 79 | 3. The detail of the main classes that take part (executed test, etc.) |
|---|
| 80 | 4. The related stack trace (if exists) |
|---|
| 81 | 5. Any other remarkable information. |
|---|
| 82 | |
|---|
| 83 | NOTE: The maximum size of the sent mail is 3MB. |
|---|
| 84 | |
|---|
| 85 | |
|---|
| 86 | ----- |
|---|
| 87 | |
|---|
| 88 | Jordi Pujol |
|---|
| 89 | Planet Project Member |
|---|
| 90 | |
|---|
| 91 | Planet: http://ants.etse.urv.es/planet |
|---|
| 92 | PlanetSim: http://ants.etse.urv.es/planetsim |
|---|
| 93 | |
|---|
| 94 | July 20, 2005 |
|---|
