| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 1 | ndn-tlv-peek |
| 2 | ============ |
| 3 | |
| Junxiao Shi | 5620fb2 | 2015-06-07 20:59:38 -0700 | [diff] [blame] | 4 | Deprecated |
| 5 | ---------- |
| 6 | |
| 7 | ndn-tlv-peek is deprecated and will be removed in a future release of NFD. |
| 8 | Please use ``ndnpeek`` program from ndn-tools repository `<https://github.com/named-data/ndn-tools>`__. |
| 9 | |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 10 | Usage |
| 11 | ----- |
| 12 | |
| 13 | :: |
| 14 | |
| 15 | ndn-tlv-peek [-h] [-f] [-r] [-m min] [-M max] [-l lifetime] [-p] [-w timeout] name |
| 16 | |
| 17 | Description |
| 18 | ----------- |
| 19 | |
| 20 | ``ndn-tlv-peek`` is a simple consumer program that sends one Interest and expects one Data |
| 21 | packet in response. The full Data packet (in TLV format) is written to stdout. The |
| 22 | program terminates with return code 0 if Data arrives, and with return code 1 when timeout |
| 23 | occurs. |
| 24 | |
| 25 | ``name`` is interpreted as the Interest name. |
| 26 | |
| 27 | Options |
| 28 | ------- |
| 29 | |
| 30 | ``-h`` |
| 31 | Print help and exit |
| 32 | |
| 33 | ``-f`` |
| 34 | If specified, set ``MustBeFresh`` selector in the Interest packet. |
| 35 | |
| 36 | ``-r`` |
| 37 | Set ``ChildSelector=1`` (the rightmost child) selector. |
| 38 | |
| 39 | ``-m`` |
| 40 | Set ``min`` as the ``MinSuffixComponents`` selector. |
| 41 | |
| 42 | ``-M`` |
| 43 | Set ``max`` as the ``MaxSuffixComponents`` selector. |
| 44 | |
| 45 | ``-l`` |
| 46 | Set ``lifetime`` (in milliseconds) as the ``InterestLifetime``. |
| 47 | |
| 48 | ``-p`` |
| 49 | If specified, print the received payload only, not the full packet. |
| 50 | |
| 51 | ``-w`` |
| 52 | Timeout after ``timeout`` milliseconds. |
| 53 | |
| 54 | |
| 55 | Examples |
| 56 | -------- |
| 57 | |
| 58 | Send Interest for ``ndn:/app1/video`` and print the received payload only |
| 59 | |
| 60 | :: |
| 61 | |
| 62 | ndn-tlv-peek -p ndn:/app1/video |