README.flowmon
author Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
Thu May 07 18:17:17 2009 +0100 (9 months ago)
changeset 3972 4c6cb7db6d87
permissions -rw-r--r--
Add a readme file explaining the purpose of this branch
     1 ns-3-flowmon
     2 ============
     3 
     4 === What is it ===
     5 
     6 Adds a flow monitoring framework module to NS-3.  With only a few
     7 lines of code a set of objects are created that will monitor IPv4
     8 flows that are being simulated.  At the end of the simulation, a few
     9 simple methods allow retrieval of the collected statistical data on
    10 the flows.  No prior configuration of any list of flows to be
    11 monitored is necessary, as the flow monitor automatically detects
    12 flows.
    13 
    14 This module is ideal for collecting results especially in Python based
    15 simulations, although it is also very useful for C++ simulations,
    16 since it avoids the need to create large disk based trace files, and
    17 already collects a large amount of useful information in a small
    18 amount of space.
    19 
    20 Note: this branch is based on http://code.nsnam.org/gjc/ns-3-pyviz/
    21 
    22 === How to use ===
    23 
    24 For an example, see examples/flowmon.py
    25 
    26 === Architecture ===
    27 
    28 TODO: write this section.
    29 
    30 For the time being, look at (possibly slightly outdated, but...)
    31 src/contrib/flow-monitor/design.txt.
    32 
    33 === Authors ===
    34 
    35 Gustavo Carneiro  <gjc@inescporto.pt> <gjcarneiro@gmail.com>
    36 Pedro Fortuna     <pedro.fortuna@inescporto.pt> <pedro.fortuna@gmail.com>
    37