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