Davide Pesavento | 2a7f32b | 2017-09-02 13:48:13 -0400 | [diff] [blame] | 1 | Traffic Generator for NDN (ndn-traffic-generator) |
Alexander Afanasyev | fda32a3 | 2014-03-20 10:50:00 -0700 | [diff] [blame] | 2 | ================================================= |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 3 | |
Davide Pesavento | 2a7f32b | 2017-09-02 13:48:13 -0400 | [diff] [blame] | 4 | [](https://travis-ci.org/named-data/ndn-traffic-generator) |
| 5 | |
jeraldabraham | 420dbf0 | 2014-04-25 22:58:31 -0700 | [diff] [blame] | 6 | This tool is designed to generate Interest and Data traffic in an NDN network. |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 7 | The client and server tool accept traffic configuration files which can be |
| 8 | used to specify the pattern of NDN traffic that is required to be generated. |
Alexander Afanasyev | fda32a3 | 2014-03-20 10:50:00 -0700 | [diff] [blame] | 9 | Sample configuration files are provided which include instructions on how |
| 10 | to configure various parameters. |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 11 | |
Alexander Afanasyev | fda32a3 | 2014-03-20 10:50:00 -0700 | [diff] [blame] | 12 | ## Prerequisites ## |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 13 | |
Alexander Afanasyev | fda32a3 | 2014-03-20 10:50:00 -0700 | [diff] [blame] | 14 | Compiling and running ndn-traffic-generator requires the following dependencies: |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 15 | |
Davide Pesavento | 29db0fd | 2017-08-29 13:32:00 -0400 | [diff] [blame] | 16 | 1. ndn-cxx library <https://github.com/named-data/ndn-cxx> |
Alexander Afanasyev | fda32a3 | 2014-03-20 10:50:00 -0700 | [diff] [blame] | 17 | |
Davide Pesavento | 29db0fd | 2017-08-29 13:32:00 -0400 | [diff] [blame] | 18 | For detailed installation instructions, please see |
| 19 | [`INSTALL.rst`](https://github.com/named-data/ndn-cxx/blob/master/docs/INSTALL.rst) |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 20 | |
Davide Pesavento | 29db0fd | 2017-08-29 13:32:00 -0400 | [diff] [blame] | 21 | 2. NDN forwarding daemon <https://github.com/named-data/NFD> |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 22 | |
| 23 | ----------------------------------------------------- |
| 24 | |
Davide Pesavento | 2a7f32b | 2017-09-02 13:48:13 -0400 | [diff] [blame] | 25 | ## 1. Compilation & Installation Instructions: ## |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 26 | |
Alexander Afanasyev | fda32a3 | 2014-03-20 10:50:00 -0700 | [diff] [blame] | 27 | ./waf configure |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 28 | ./waf |
| 29 | sudo ./waf install |
| 30 | |
Davide Pesavento | 2a7f32b | 2017-09-02 13:48:13 -0400 | [diff] [blame] | 31 | |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 32 | ## 2. Tool Run Instructions & Command Line Options: ## |
| 33 | |
Davide Pesavento | 3518533 | 2019-01-14 04:00:15 -0500 | [diff] [blame^] | 34 | Usage: ndn-traffic-server [options] <Traffic_Configuration_File> |
| 35 | Respond to Interests as per provided Traffic_Configuration_File. |
jeraldabraham | 420dbf0 | 2014-04-25 22:58:31 -0700 | [diff] [blame] | 36 | Multiple prefixes can be configured for handling. |
Davide Pesavento | 3518533 | 2019-01-14 04:00:15 -0500 | [diff] [blame^] | 37 | Set the environment variable NDN_TRAFFIC_LOGFOLDER to redirect output to a log file. |
| 38 | Options: |
| 39 | -h [ --help ] print this help message and exit |
| 40 | -c [ --count ] arg maximum number of Interests to respond to |
| 41 | -d [ --delay ] arg (=0) wait this amount of milliseconds before responding to each Interest |
| 42 | -q [ --quiet ] turn off logging of Interest reception/Data generation |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 43 | |
Davide Pesavento | 3518533 | 2019-01-14 04:00:15 -0500 | [diff] [blame^] | 44 | Usage: ndn-traffic [options] <Traffic_Configuration_File> |
| 45 | Generate Interest traffic as per provided Traffic_Configuration_File. |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 46 | Interests are continuously generated unless a total number is specified. |
Davide Pesavento | 3518533 | 2019-01-14 04:00:15 -0500 | [diff] [blame^] | 47 | Set the environment variable NDN_TRAFFIC_LOGFOLDER to redirect output to a log file. |
| 48 | Options: |
| 49 | -h [ --help ] print this help message and exit |
| 50 | -c [ --count ] arg total number of Interests to be generated |
| 51 | -i [ --interval ] arg (=1000) Interest generation interval in milliseconds |
| 52 | -q [ --quiet ] turn off logging of Interest generation/Data reception |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 53 | |
| 54 | |
| 55 | ## 3. Sample Run Instructions ## |
| 56 | |
| 57 | __ON MACHINE #1__ |
| 58 | |
Davide Pesavento | 2a7f32b | 2017-09-02 13:48:13 -0400 | [diff] [blame] | 59 | (NFD must be running) |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 60 | |
Davide Pesavento | 2a7f32b | 2017-09-02 13:48:13 -0400 | [diff] [blame] | 61 | Start traffic server: |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 62 | |
Alexander Afanasyev | fda32a3 | 2014-03-20 10:50:00 -0700 | [diff] [blame] | 63 | ndn-traffic-server ndn-traffic-server.conf |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 64 | |
| 65 | __ON MACHINE #2__ |
| 66 | |
Davide Pesavento | 2a7f32b | 2017-09-02 13:48:13 -0400 | [diff] [blame] | 67 | (NFD must be running) |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 68 | |
Davide Pesavento | 2a7f32b | 2017-09-02 13:48:13 -0400 | [diff] [blame] | 69 | Start the traffic client: |
Alexander Afanasyev | fda32a3 | 2014-03-20 10:50:00 -0700 | [diff] [blame] | 70 | |
| 71 | ndn-traffic ndn-traffic-client.conf |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 72 | |
Alexander Afanasyev | a8f2a92 | 2014-02-26 14:21:56 -0800 | [diff] [blame] | 73 | * These tools need not be used together and can be used individually as well. |
Davide Pesavento | 3518533 | 2019-01-14 04:00:15 -0500 | [diff] [blame^] | 74 | * Please refer to the sample configuration files provided for details on how to create your own. |
| 75 | * Use the command line options shown above to adjust traffic configuration. |