1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README.flowmon	Thu May 07 18:17:17 2009 +0100
     1.3 @@ -0,0 +1,37 @@
     1.4 +ns-3-flowmon
     1.5 +============
     1.6 +
     1.7 +=== What is it ===
     1.8 +
     1.9 +Adds a flow monitoring framework module to NS-3.  With only a few
    1.10 +lines of code a set of objects are created that will monitor IPv4
    1.11 +flows that are being simulated.  At the end of the simulation, a few
    1.12 +simple methods allow retrieval of the collected statistical data on
    1.13 +the flows.  No prior configuration of any list of flows to be
    1.14 +monitored is necessary, as the flow monitor automatically detects
    1.15 +flows.
    1.16 +
    1.17 +This module is ideal for collecting results especially in Python based
    1.18 +simulations, although it is also very useful for C++ simulations,
    1.19 +since it avoids the need to create large disk based trace files, and
    1.20 +already collects a large amount of useful information in a small
    1.21 +amount of space.
    1.22 +
    1.23 +Note: this branch is based on http://code.nsnam.org/gjc/ns-3-pyviz/
    1.24 +
    1.25 +=== How to use ===
    1.26 +
    1.27 +For an example, see examples/flowmon.py
    1.28 +
    1.29 +=== Architecture ===
    1.30 +
    1.31 +TODO: write this section.
    1.32 +
    1.33 +For the time being, look at (possibly slightly outdated, but...)
    1.34 +src/contrib/flow-monitor/design.txt.
    1.35 +
    1.36 +=== Authors ===
    1.37 +
    1.38 +Gustavo Carneiro  <gjc@inescporto.pt> <gjcarneiro@gmail.com>
    1.39 +Pedro Fortuna     <pedro.fortuna@inescporto.pt> <pedro.fortuna@gmail.com>
    1.40 +