| Eric Newberry | 7f25a11 | 2015-05-31 11:23:25 -0700 | [diff] [blame] | 1 | ndnping |
| 2 | ======= |
| 3 | |
| 4 | Usage |
| 5 | ----- |
| 6 | |
| 7 | :: |
| 8 | |
| 9 | ndnping [-h] [-V] [-i interval] [-o timeout] [-c count] [-n start] [-p identifier] [-a] [-t] prefix |
| 10 | |
| 11 | Description |
| 12 | ----------- |
| 13 | |
| 14 | ``ndnping`` is a reachability testing tool that sends Interest packets and expects Data packets in |
| 15 | response. If Data packets are not received within the timeout period for their Interest, |
| 16 | ``ndnping`` marks them as timed out. If ``ndnping`` does receive a Data packet within the timeout, |
| 17 | the time from sending the Interest to receiving the Data is recorded and displayed. Once |
| 18 | ``ndnping`` either reaches the specified total number of Interests to be sent or receives an |
| 19 | interrupt signal, it prints statistics on the Interests, including the number of Interests sent, |
| 20 | the number of Data packets received, and the average response time of the Data. |
| 21 | |
| 22 | ``prefix`` is interpreted as the Interest prefix. The name of the sent Interest consists of the |
| 23 | prefix followed by "ping", the optional identifier specified by the '-p' option, and finally a |
| 24 | sequence number as a decimal number string. |
| 25 | |
| 26 | Options |
| 27 | ------- |
| 28 | |
| 29 | ``-h`` |
| 30 | Print help and exit. |
| 31 | |
| 32 | ``-V`` |
| 33 | Print version and exit. |
| 34 | |
| 35 | ``-i`` |
| 36 | Set ping interval in milliseconds (default 1000ms - minimum 1ms). |
| 37 | |
| 38 | ``-o`` |
| 39 | Set ping timeout in milliseconds (default 4000ms). |
| 40 | |
| 41 | ``-c`` |
| 42 | Set total number of Interests to be sent. |
| 43 | |
| 44 | ``-n`` |
| 45 | Set the starting sequence number, which is incremented by 1 after each Interest sent. |
| 46 | |
| 47 | ``-p`` |
| 48 | Adds specified identifier to the Interest names before the numbers to avoid conflict. |
| 49 | |
| 50 | ``-a`` |
| 51 | Allows routers to return stale Data from cache. |
| 52 | |
| 53 | ``-t`` |
| 54 | Prints a timestamp with received Data and timeouts. |
| 55 | |
| 56 | Examples |
| 57 | -------- |
| 58 | |
| 59 | Test reachability for ``ndn:/edu/arizona`` using 4 Interest packets and print timestamp |
| 60 | |
| 61 | :: |
| 62 | |
| 63 | ndnping -c 4 -t ndn:/edu/arizona |