| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 1 | ndn-tlv-poke |
| 2 | ============ |
| 3 | |
| Junxiao Shi | 5620fb2 | 2015-06-07 20:59:38 -0700 | [diff] [blame^] | 4 | Deprecated |
| 5 | ---------- |
| 6 | |
| 7 | ndn-tlv-poke is deprecated and will be removed in a future release of NFD. |
| 8 | Please use ``ndnpoke`` 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-poke [-h] [-f] [-D] [-i identity] [-F] [-x freshness] [-w timeout] name |
| 16 | |
| 17 | Description |
| 18 | ----------- |
| 19 | |
| 20 | ``ndn-tlv-poke`` is a simple producer program that reads payload from stdin and publishes it |
| 21 | as a single NDN Data packet. The Data packet is published either as a response to the |
| 22 | incoming Interest for the given ``name``, or forcefully pushed to the local NDN |
| 23 | forwarder's cache if ``-f`` flag is specified. |
| 24 | |
| 25 | The program terminates with return code 0 if Data is sent and with return code 1 when |
| 26 | timeout occurs. |
| 27 | |
| 28 | Options |
| 29 | ------- |
| 30 | |
| 31 | ``-h`` |
| 32 | Print usage and exit. |
| 33 | |
| 34 | ``-f`` |
| 35 | If specified, send Data without waiting for Interest. |
| 36 | |
| 37 | ``-D`` |
| 38 | If specified, use ``DigestSha256`` signature instead of default ``SignatureSha256WithRsa``. |
| 39 | |
| 40 | ``-i`` |
| 41 | Use ``identity`` to sign the created Data packet. |
| 42 | |
| 43 | ``-F`` |
| 44 | Set ``FinalBlockId`` to the last component of specified name. |
| 45 | |
| 46 | ``-x`` |
| 47 | Set ``FreshnessPeriod`` in milliseconds. |
| 48 | |
| 49 | ``-w`` |
| 50 | Wait at most ``timeout`` milliseconds for the incoming Interest. If no Interest arrives |
| 51 | within the ``timeout``, the Data packet will not be published. |
| 52 | |
| 53 | |
| 54 | Examples |
| 55 | -------- |
| 56 | |
| 57 | Create Data packet with content ``hello`` with the name ``ndn:/app/video`` and wait at |
| 58 | most 3 seconds for the incoming Interest for it:: |
| 59 | |
| 60 | echo "Hello" | build/bin/ndn-tlv-poke -w 3000 ndn:/app/video |