Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-traffic-generator / 2a7f32be9fc287d910ab45bbdfd4a925ac5f0923 / . / README.md
blob: 7a3f2503501669eed13740a1b283468e32f68d20 [file] [log] [blame] [view]
Davide Pesavento2a7f32b2017-09-02 13:48:13 -0400[diff] [blame^]1Traffic Generator for NDN (ndn-traffic-generator)
Alexander Afanasyevfda32a32014-03-20 10:50:00 -0700[diff] [blame]2=================================================
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]3
Davide Pesavento2a7f32b2017-09-02 13:48:13 -0400[diff] [blame^]4[![Build Status](https://travis-ci.org/named-data/ndn-traffic-generator.svg?branch=master)](https://travis-ci.org/named-data/ndn-traffic-generator)
5
jeraldabraham420dbf02014-04-25 22:58:31 -0700[diff] [blame]6This tool is designed to generate Interest and Data traffic in an NDN network.
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]7The client and server tool accept traffic configuration files which can be
8used to specify the pattern of NDN traffic that is required to be generated.
Alexander Afanasyevfda32a32014-03-20 10:50:00 -0700[diff] [blame]9Sample configuration files are provided which include instructions on how
10to configure various parameters.
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]11
Alexander Afanasyevfda32a32014-03-20 10:50:00 -0700[diff] [blame]12## Prerequisites ##
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]13
Alexander Afanasyevfda32a32014-03-20 10:50:00 -0700[diff] [blame]14Compiling and running ndn-traffic-generator requires the following dependencies:
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]15
Davide Pesavento29db0fd2017-08-29 13:32:00 -0400[diff] [blame]161. ndn-cxx library <https://github.com/named-data/ndn-cxx>
Alexander Afanasyevfda32a32014-03-20 10:50:00 -0700[diff] [blame]17
Davide Pesavento29db0fd2017-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 Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]20
Davide Pesavento29db0fd2017-08-29 13:32:00 -0400[diff] [blame]212. NDN forwarding daemon <https://github.com/named-data/NFD>
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]22
23-----------------------------------------------------
24
Davide Pesavento2a7f32b2017-09-02 13:48:13 -0400[diff] [blame^]25## 1. Compilation & Installation Instructions: ##
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]26
Alexander Afanasyevfda32a32014-03-20 10:50:00 -0700[diff] [blame]27 ./waf configure
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]28 ./waf
29 sudo ./waf install
30
Davide Pesavento2a7f32b2017-09-02 13:48:13 -0400[diff] [blame^]31
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]32## 2. Tool Run Instructions & Command Line Options: ##
33
jeraldabraham420dbf02014-04-25 22:58:31 -0700[diff] [blame]34 Usage: ndn-traffic-server [options] <traffic_configuration_file>
35 Respond to Interest as per provided traffic configuration file
36 Multiple prefixes can be configured for handling.
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]37 Set environment variable NDN_TRAFFIC_LOGFOLDER for redirecting output to a log.
jeraldabrahamcc3c6c92014-03-28 02:21:45 -0700[diff] [blame]38 [-d interval] - set delay before responding to interest in milliseconds
39 [-c count] - specify maximum number of interests to be satisfied
jeraldabraham420dbf02014-04-25 22:58:31 -0700[diff] [blame]40 [-q] - quiet logging - no interest reception/data generation messages
41 [-h] - print help and exit
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]42
jeraldabraham420dbf02014-04-25 22:58:31 -0700[diff] [blame]43 Usage: ndn-traffic [options] <traffic_configuration_file>
44 Generate Interest traffic as per provided traffic configuration file
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]45 Interests are continuously generated unless a total number is specified.
46 Set environment variable NDN_TRAFFIC_LOGFOLDER for redirecting output to a log.
jeraldabrahamcc3c6c92014-03-28 02:21:45 -0700[diff] [blame]47 [-i interval] - set interest generation interval in milliseconds (default 1000 milliseconds)
jeraldabraham420dbf02014-04-25 22:58:31 -0700[diff] [blame]48 [-c count] - set total number of interests to be generated
49 [-q] - quiet logging - no interest reception/data generation messages
50 [-h] - print help and exit
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]51
52
53## 3. Sample Run Instructions ##
54
55__ON MACHINE #1__
56
Davide Pesavento2a7f32b2017-09-02 13:48:13 -0400[diff] [blame^]57(NFD must be running)
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]58
Davide Pesavento2a7f32b2017-09-02 13:48:13 -0400[diff] [blame^]59Start traffic server:
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]60
Alexander Afanasyevfda32a32014-03-20 10:50:00 -0700[diff] [blame]61 ndn-traffic-server ndn-traffic-server.conf
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]62
63__ON MACHINE #2__
64
Davide Pesavento2a7f32b2017-09-02 13:48:13 -0400[diff] [blame^]65(NFD must be running)
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]66
Davide Pesavento2a7f32b2017-09-02 13:48:13 -0400[diff] [blame^]67Start the traffic client:
Alexander Afanasyevfda32a32014-03-20 10:50:00 -0700[diff] [blame]68
69 ndn-traffic ndn-traffic-client.conf
Alexander Afanasyeva8f2a922014-02-26 14:21:56 -0800[diff] [blame]70
71
72* These tools need not be used together and can be used individually as well.
73* Please refer sample configuration files provided for details on how to create your own.
74* Use command line options shown above to adjust traffic configuration.