readme.txt

一个小型网络仿真器的实现

README (JaNetSim 0.62)
======================

JaNetSim is a Java-based network simulator developed at the Network
Research Lab, Faculty of Computer Science and Information Technology,
University of Malaya.

It is a discrete-event simulator intended for network design, protocol
analysis and any network-related research. The simulation engine is
based on the NIST ATM/HFC Network Simulator, which is in turn based on
the MIT ACS Advanced Network Architecture group's Netsim.

The Java programming language is used for the development of the
entire simulator including the simulator core engine, the GUI and
the simulation components.

It is an ongoing project and the program is modified/enhanced frequently.


Package Content
---------------

The package contains:

readme.txt             (this file)
go, go.bat             (shortcut script to run the application)
filter.class           (a filter program for filtering log files)
programmer's guide.pdf (programmer's guide)
checklist.txt          (hints for creating components)
janetsim.cfg           (simulation configuration file)
janetsim\              (all the application .java and .class files)
others\                (other .java files)
images\                (image files used by certain components)


Installation
------------

The software requires that JDK1.3.0 or above is installed in your
machine. Any platforms that support Java (Windows, Linux, Solaris etc)
should be able to run the program.

No specific installation steps are needed. Just unpack the package
into a directory/folder.


Running
-------

Run the go (Unix) or go.bat (Windows) script.

OR

Manually run the main java class by:

  java -classpath . janetsim.Sim

  (this assumes you are at the installation directory, if not,
   use an appropriate classpath)

For command line options, use: go -h


Documentation
-------------

Refer the programmer's guide for explanation of the basic organization
of the simulator and the API for developing network components.

A user guide is temporarily unavailable (hopefully soon after
the restructure). Use the Quick Help command in the Help menu to
get started.


Contact
-------

Please check our web site for new release:

  http://nrl.fsktm.um.edu.my/janetsim/

Please e-mail me for any problems/bug-report/etc. Thank you!

  S. H. Lim
  [e-mail]



January 2002



===============================================================================================
Partial Change History
----------------------

Changes in version (0.62)
--------------------------

1. Thoroughly improved thread control
2. Added Animation API to support per-component animation
3. Added memory status check (and force garbage collection)

Changes in version (0.61b)
--------------------------

1. Added EtherSwitch, IPRouter, UDP_CBR and associated components
2. Added ARP
3. Added the Analyzer module
4. Updated user interface (link & app tagging during drag)


Changes in version (0.6)
------------------------

1. Thorough architecture change. Refer the new documentation for details.


Changes in version (0.5)
------------------------

1. Fixed a routing table lookup bug (longest-match compare of default route).
2. TCP source.
3. BGP temporary.


Changes in version (0.46)
-------------------------

1. Better Diffserv.
2. Better easy IP (allows more 1 CBR per BTE using this style)
   (BTE IP = tag.tag.tag.0 with mask 255.255.255.0)
   (source CBR IP = tag.tag.tag.port) (EF class only!)
3. Better Global Set Value.
4. No longer serially compatible with previous 0.4x versions.
   (But replace the "2" to GET_DS_CLASS compInfo already)
5. Fixed silly age clock bug.
6. Various bug-fixes and enhancements.


Changes in version (0.45exp)
----------------------------

1. Improved routing update scheme.
2. Initial topology image save function.


Changes in version (0.45)
-------------------------

1. Added full AF class and WRR for diffserv.
2. Refine the report dialog.

NOTE: Use value "2" implicitly for GET_DS_CLASS compInfo, 
        must define explicitly in next version!!! (this is to avoid serialization problem!)

3. Various bug-fixes and enhancements.


Changes in version (0.44)
-------------------------

1. Added "Save/Load Topology" commands for portable topology files (usable
   even in future versions).
2. Added "select by class/type/prefix" commands.
3. Added the temporary "analyse" command.
4. Added non-interactive clock display.
5. Fixed some diffserv problems.
6. Various bug-fixes and enhancements.


Changes in version (0.43)
-------------------------

1. Added DiffServ.
2. Various bug-fixes and enhancements.


Changes in version (0.42)
-------------------------

1. Enhance all the IP-based applications, including delay measurement
   and other controls.
2. Fixed multiple LSP per FEC bug in ATMLSR.
3. Various bug-fixes and enhancements.


Changes in version (0.4)
------------------------

1. Added a few components (some generic, some IP, MPLS related)
2. Added globalSetValue() in SimParameter to support setting same
   parameter values of multiple components at the same time.
3. Added command line parameters for non-interactive simulation
   sessions (including auto repeat, pre/post-processing etc).
   (enter 'go -h' to see the usage notes)
4. Added a filter utility (filter.class) to filter and shrink the
   simulation log file. (enter 'java filter' to see the usage notes)
   (NOTE: this is not part of the javasim package)
5. Tagging support for SimComponent.
6. Switched to JDK1.3.
7. Various bug-fixes and enhancements.


===============================================================================================


DISCLAIMER
----------

This software was developed at the Network Research Lab, Faculty of
Computer Science and Information Technology (FCSIT), University of Malaya.
This software may be used and distributed freely. FCSIT assumes no responsibility
whatsoever for its use by other parties, and makes no guarantees, expressed or
implied, about its quality, reliability, or any other characteristic.

We would appreciate acknowledgement if the software is used.

FCSIT ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" CONDITION AND
DISCLAIM ANY LIABILITY OF ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING
FROM THE USE OF THIS SOFTWARE.


===============================================================================================