programs: pingclient

.travis.yml

@@ -51,24 +51,24 @@ install:
 
 script:
   - cd $TRAVIS_BUILD_DIR && mk/update-list.sh
-  - meson build.coverage -Db_coverage=true -Dwerror=true -Dunittest=enabled
+  - meson build.coverage -Db_coverage=true -Dwerror=true -Dunittest=enabled -Dprograms=disabled
   - ninja -C build.coverage test
   - |
-    travis_fold start "build.coverage/testlog"
+    travis_fold start "coverage-testlog"
     cat build.coverage/meson-logs/testlog.txt
-    travis_fold end "build.coverage/testlog"
-  - meson build.sanitize -Db_sanitize=address,undefined -Dunittest=enabled
+    travis_fold end "coverage-testlog"
+  - meson build.sanitize -Db_sanitize=address,undefined -Dunittest=enabled -Dprograms=enabled
   - ninja -C build.sanitize test
   - |
-    travis_fold start "build.sanitize/testlog"
+    travis_fold start "sanitize-testlog"
     cat build.sanitize/meson-logs/testlog.txt
-    travis_fold end "build.sanitize/testlog"
-  - LDFLAGS='-fuse-ld=lld -L/usr/local/lib' meson build.llvm --native-file mk/native-llvm.txt --buildtype debugoptimized -Dunittest=enabled
+    travis_fold end "sanitize-testlog"
+  - LDFLAGS='-fuse-ld=lld -L/usr/local/lib' meson build.llvm --native-file mk/native-llvm.txt --buildtype debugoptimized -Dunittest=enabled -Dprograms=enabled
   - ninja -C build.llvm test
   - |
-    travis_fold start "build.llvm/testlog"
+    travis_fold start "llvm-testlog"
     cat build.llvm/meson-logs/testlog.txt
-    travis_fold end "build.llvm/testlog"
+    travis_fold end "llvm-testlog"
   - build_platform esp8266
   - build_platform esp32
   - build_platform nrf52840

README.md

@@ -4,7 +4,7 @@
 
 **NDNph** provides [Named Data Networking](https://named-data.net/) packet encoding and more in a header-only C++11 library. It is part of [esp8266ndn](https://github.com/yoursunny/esp8266ndn) that supports microcontroller programming in Arduino IDE. NDNph can also work independently on Linux and other platforms.
 
-* [Doxygen documentation](https://esp8266ndn.netlify.com/) together with esp8266ndn
+* [Doxygen documentation](https://esp8266ndn.ndn.today/) together with esp8266ndn
 * [#NDNph on Twitter](https://twitter.com/hashtag/NDNph) for announcements
 * [ndn-lib mailing list](https://www.lists.cs.ucla.edu/mailman/listinfo/ndn-lib) for best-effort support
 

examples/README.md

@@ -1,4 +1,7 @@
 # NDNph Examples
 
-This examples directory is to allow Arduino IDE to locate the unit tests.
-For examples on how to use NDNph, please see [esp8266ndn](https://github.com/yoursunny/esp8266ndn) library.
+This examples directory is to allow running unit tests in Arduino IDE.
+Examples on how to use NDNph in a program can be found in:
+
+* [../programs](programs) directory: NDNph on Linux
+* [esp8266ndn](https://github.com/yoursunny/esp8266ndn) library: NDNph on microcontrollers

meson.build

@@ -7,3 +7,12 @@ project('NDNph', 'cpp',
   ])
 subdir('src')
 subdir('tests')
+
+programs_option = get_option('programs')
+if not programs_option.disabled()
+  if has_all_linux_deps
+    subdir('programs')
+  elif programs_option.enabled()
+    error('programs enabled but is missing dependency')
+  endif
+endif

meson_options.txt

@@ -1 +1,2 @@
 option('unittest', type: 'feature')
+option('programs', type: 'feature')

programs/README.md

@@ -0,0 +1,3 @@
+# NDNph Linux Examples
+
+This directory contains several self-contained programs using NDNph.

programs/meson.build

@@ -0,0 +1 @@
+executable('ndnph-pingclient', 'pingclient.cpp', dependencies: [lib_dep])

programs/pingclient.cpp

@@ -0,0 +1,63 @@
+#include <NDNph-config.h>
+#include <NDNph.h>
+
+#include <cinttypes>
+#include <cstdio>
+#include <unistd.h>
+
+ndnph::UdpUnicastTransport transport;
+ndnph::Face face(transport);
+
+std::unique_ptr<ndnph::PingClient> client;
+
+static bool
+parseArgs(int argc, char** argv)
+{
+  int interval = 1000;
+
+  int c;
+  while ((c = getopt(argc, argv, "i:")) != -1) {
+    switch (c) {
+      case 'i': {
+        interval = atoi(optarg);
+        if (interval <= 0 || interval > 60000) {
+          return false;
+        }
+        break;
+      }
+    }
+  }
+
+  if (argc - optind != 1) {
+    return false;
+  }
+  const char* prefix = argv[optind];
+
+  static ndnph::StaticRegion<1024> prefixRegion;
+  client.reset(new ndnph::PingClient(ndnph::Name::parse(prefixRegion, prefix), face, interval));
+  return true;
+}
+
+int
+main(int argc, char** argv)
+{
+  if (!parseArgs(argc, argv)) {
+    fprintf(stderr, "ndnph-pingclient [-i INTERVAL] PREFIX\n"
+                    "  PREFIX should have 'ping' suffix to interact with ndn-tools ndnpingserver\n"
+                    "  INTERVAL must be between 1 and 60000 milliseconds\n"
+                    "  INTERVAL should be no less than RTT, or all requests will timeout\n");
+    return 2;
+  }
+
+  transport.beginTunnel({ 127, 0, 0, 1 });
+  for (;;) {
+    ndnph::port::Clock::sleep(1);
+    face.loop();
+
+    static uint16_t i = 0;
+    if (++i % 1024 == 0) {
+      auto cnt = client->readCounters();
+      printf("%" PRIu32 "I %" PRIu32 "D\n", cnt.nTxInterests, cnt.nRxData);
+    }
+  }
+}

src/meson.build

@@ -32,6 +32,8 @@ if not have_this_thread
   conf.set('NDNPH_PORT_CHRONO_BUSY_SLEEP', '')
 endif
 
+has_all_linux_deps = boost.found() and mbedcrypto.found() and have_urandom and have_socket_h
+
 config_h = configure_file(output: 'NDNph-config.h', configuration: conf)
 lib_dep = declare_dependency(
   include_directories: include_directories('.'),

src/ndnph/app/ping-client.hpp

@@ -6,13 +6,19 @@
 
 namespace ndnph {
 
-/** @brief Periodically transmit Interests to test reachability. */
+/**
+ * @brief Periodically transmit Interests to test reachability.
+ *
+ * This is a simple ping client implementation that can only keep one pending Interest.
+ * After sending a probe Interest, responses to previous Interests are no longer accepted.
+ * Therefore, interval must be greater than RTT, otherwise this client cannot receive any Data.
+ */
 class PingClient : public PacketHandler
 {
 public:
   /**
    * @brief Constructor.
-   * @param prefix name prefix to request.
+   * @param prefix name prefix to request. It should have 'ping' suffix.
    * @param face face for communication.
    * @param interval Interest interval in milliseconds.
    */

src/ndnph/app/ping-server.hpp

@@ -12,7 +12,7 @@ class PingServer : public PacketHandler
 public:
   /**
    * @brief Constructor.
-   * @param prefix name prefix to serve.
+   * @param prefix name prefix to serve. It should have 'ping' suffix.
    * @param face face for communication.
    */
   explicit PingServer(Name prefix, Face& face)

tests/unittest/meson.build

@@ -1,6 +1,6 @@
 gmock = dependency('gmock', required: false)
 gtest = dependency('gtest', main: true, required: false)
-if gmock.found() and gtest.found() and boost.found() and mbedcrypto.found() and have_urandom and have_socket_h
+if gmock.found() and gtest.found() and has_all_linux_deps
   unittest_exe = executable('unittest',
     unittest_files,
     dependencies: [lib_dep, gmock, gtest],