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