every parts are wroking, implemented ndnsd-tool completly and also th…

.gitignore

@@ -29,4 +29,8 @@ __pycache__/
 *.py[cod]
 
 # Other
-/VERSION
+/VERSION
+
+
+RESOURCES/
+thesis/

README.md

@@ -0,0 +1,2 @@
+# NDNSD
+NDN Service Discovery

docs/Directory Service.drawio

@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2020-04-28T18:52:05.325Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.163 Safari/537.36" etag="GbPo3MfWbHfdJnHgaSCE" version="13.0.2" type="github"><diagram id="_BzWF5qOBLh8jlFu-Lp9" name="Page-1">7Vxbb6s4EP41kXYfgnzBQB6b3lY62qNKXWm7jwTcBC0BDpA22V+/doAAxgSacGnT9KV4ABPP99kzHo89wbfr7WNoBqs/fZu6EwTs7QTfTRCC+kxj/7hkl0hUQ00Ey9Cx04dywbPzH02FIJVuHJtGpQdj33djJygLLd/zqBWXZGYY+u/lx159t/zVwFzSiuDZMt2q9G/HjleJ1CAgl/9BneUq+zIE6Z21mT2cCqKVafvvBRG+n+Db0Pfj5Gq9vaUuV16ml+S9h5q7hx8WUi9u8wL6ob38jBePa+vlxwN8efrl64spSdF4M91N2uL018a7TAXvKyemz4Fp8fI7g3mC56t47bISZJdmFCSKf3W2lH1rbpvRil/s7/LCkxnHNPT2EgS4NIpD/19667t+uP8GBvM7Tb0/3MlUzZ9NfyANY7qtbTo8KJQxkfprGoc79kj6woFNGQnT4nuOKDFS2aqA5kFopixaHqrOFc0uUl1/RO9QonfNZd+dL9jFMt43PBG8+qyVRUS0Xxs/uzGN9l3mhiuWBNv8ZqEWc80h8xZRsC+D7ylKlMnQSvRZ1jETV/S+CI9KRm/QVXQVXUVX0cgisSx4D6G/8eyDO9DgS1Stv8+edWJut5nL1cq36MBfwIiU/AWk6gqpuAxq5kYUXQYNZU927jOo+OozXH2Gq+gquoquom8gugRPQtVKngQkEj8CqpLQA+jJi0CgOeKzZKoOalufhtrMRfY4+KhWphooaYVAUNEKnpGqVlStN7XIAjKdq+UIIvXKUsvKmkqUpWKJK4p7UxacNSsr763glN5ajhB6vkfbdsgj8FZ1PKIOa5351r67KvPdH2Gt2yogxH6kE0S0GZ1KhPfVcd1C8NYm1LDVCmjsjoEWWNPOQ+5479DLnQNX+4YmgbW/YaQW1SgwvTNQxQVUk6ouGVUkGAhojIyrbJmkE1zR98IVlnHVRoaVSGB9sJ3I8lnj2WUQOl7MrwQwmF5iQeuus+S+o0X3L+A5155jme5NemPt2DZ/fR5SRorUS+CmMfDZN/YNI/MJueN1bWI/IU77BbBT0JBo/7B8WVQ/6kv92jH173iPoF7kX6r6xc4gsV0QDgmH3gTH0lzTcAoAvFREsGB2iAQSmZvYGyQZ/p0bnls4vOExqfFqyQyPZhl08donskJXQ5I51KCGB1bd/0ceA+FX4HnnWezfI59uKnVB6TyuTE1rxSFL3konqcDas4NNSmPT8Zor4RMsBPhYC9Z+yK+D0Lc3Fg0j/rv0+RP7xayt4In/bEVRJvrdhY4CcCas/uhVsiCZnewtZgNlforYTT37huc7cWW7ZhQ5VhmJ5AVqV9KdTlRWMXfmiC5C6pqx81b+qExB6ReeOOxVF2UnqD2rIfI3oUXTl3ItV+qZCQO7OGDHZrikcaWePVqHRp8BoMzT+RYACvPziqVsCyAUZ4TqwAjKnKNvgaAhIIhPRVCkAhwYQaOC4K3vRZv15c3vMg1Loia6hCi9ea+oPmPhvASFdF4etQ11fj48G5aNhL4CJS7IsEjWB8DOC1dHNHz7rECWVyXUbqAlsBla2VSkP2hlzmUXndRZm0s6NT3Pj5n98b3vg7HWAuNh4whI5oB20X+zkbj1qtOXG4qFmND4RlXmiXZpVNGlQqkCAUpJAHxYKKsuaTdQejR2zcWl4khIM47DmlBZPkRHOL47ke2vPyWUvdhOVQz5SMbb2ZDgZuN/5+Ba3ud0ibpwgFoYTVn2fH8gdpBuIwUxvGAUdXHVROLGDosikqD4wSAca3u4e+FaVEhW/CdV6r5wty2VdsXSEw0d1hQOVSLcOnFSl0rSIq8LKiAr5rXxwq5QEOuaNEcHs3XXfcTtmD1K4y5JRK1xWjBWZFEVl1t1gThtQ4uqEKMcOryPW+yi/gAvNQ0XmTkFCjyFnF0SCrUlFB6TUNgoZ1sjIFTRllBY9DBFZvZNqA4W/AqEQrrR4VBXHunQ1xjo9FF5KYZzZycOdKPzsoN1zAIvVTTsONdMk9mYNCGYXAhNOlgsLdKE6F0OX6Xxa9TRS21LS2PU0UtInkBAPY2WKgIKQOW6Bl7Gx7KI2weZ2SUDSEsG4Ob9K30OTNkxQeem4WgQKjNjdvgzytWK6XZ9k6HFNqZBp5OjMGvU5BKiCrl2pzKLQGFgybg1EJeycawrk6eKnhE50+rBgtUDymzc+ETr6SQZlZx4pjBXSkeqhnXNEBgmZnu2toIAKwDnY+BM2CGsD0zcFhtfG4mbh8FQeXY4rn/VmmbqyDQrMUB0ib4qsZCEWMJxNXf55hKwPwmx1dEqVFkqEx7iezjkte+f4DVMg5C+OtvDjbSK4jYWgdxfLSpPhGCnLLdEtvop5m12t/pZD/R5aysFzD7hAks/2WGANIErO6iytxUXtT5DofX+I1xzxNTHGHK0luqxS/VnNh3d7PTVBgMkHA4hyzRDgxKmg1QIdBTqTPBMwzfH4juV/toFtG6H03FL8ltx09Tvkjqatl41WaKjhujh0tOYkRCHhKB6+s2wO6mI1Fa1PQjuwKSbIHCZlnlWa9SOaScwJUn+4bk/X50GqEwDBPHILgupbkx4cJbJ8JOPK0Xv9Ke5ptF+6yuTMx0uJXsqvzhMqmBLMJb0Vtk86ARjwor5yefJjCM/Px7f/w8=</diagram></mxfile>

docs/seq_diagram_small.uml

@@ -0,0 +1,29 @@
+@startuml
+participant "Consumer \n (C)" as C
+participant "ndnsd \n (d1)" as d1
+participant "ndnsd \n (d2)" as d2
+participant "Producer \n (P)" as P
+
+skinparam SequenceMessageAlign center
+skinparam style strictuml
+
+P -> d2: publish service \n (type: printers, \n name: printer1 etc)
+d2 -> P: status code \n (success, failed)
+C -> d1: request service \n (e.g. printers)
+d1 -> d1: Get service names \n (e.g. /printer1) via sync
+
+d1 -> d2: Interest (**I**): /printer1
+
+note over d2
+send NACK if
+service has expired
+end note
+
+d2 -> d1: Application NACK
+note over d2
+else send data
+end note
+
+d2 -> d1: Data (**D**) : name = /printer1 \n content: "HP ledger jet"
+d1 -> C: send response \n (service info/status)
+@enduml

docs/sequence_diagram_big.uml

@@ -0,0 +1,36 @@
+@startuml
+participant "Consumer \n (C)" as C
+participant "NDNSD \n (d1)" as d1
+participant "NDNSD \n (d2)" as d2
+participant "Producer \n (P)" as P
+
+skinparam SequenceMessageAlign center
+skinparam style strictuml
+
+P -> d2: publish service \n (type: printers, \n name: printer1 etc)
+d2 -> P: status code
+d2<--] : publish service "printer2" \n some other producer
+C -> d1: request service \n (e.g. printers)
+d1 -> d1: Get service names (/printer1, /printer2) via sync
+
+d1 -> d2 : iteratively fetch service info
+        loop each for service name
+            d1 -> d2: **I1:** /printer1, **I2:** /printer2
+        end
+
+note over d2
+send NACK if
+service has expired
+end note
+
+d2 -> d1: NACK
+note over d2
+else send data
+end note
+
+d2 -> d1: Data (**D2**) : name = /printer1 \n content: "HP ledger jet"
+d2 -> d1: Data (**D2**) : name = /printer2 \n content: "HP jet 400"
+
+d1 -> C: send D1
+d1 -> C: send D2
+@enduml

docs/sequence_diagram_ndnsd_psync.uml

@@ -0,0 +1,40 @@
+@startuml
+participant "ndnsd \n (d1)" as d1
+participant "sync \n (s1)" as s1
+participant "sync \n (s2)" as s2
+participant "ndnsd \n (d2)" as d2
+
+
+skinparam SequenceMessageAlign center
+skinparam style strictuml
+
+note over s1,s2
+Send periodic sync interest
+end note
+s1 -> s2: Sync interest: /<sync-prefix>/IBF1
+s2 -> s1: Sync interest: /<sync-prefix>/IBF1
+
+note over d1
+Advertise service:
+/printer1/1
+end note
+d1 -> s1: p: /printer1/1
+
+note over s1
+Publish service: /printer1/1
+insert into IBF1, get IBF2 
+Answer pending interest
+end note
+s1 -> s2: Sync Data: /<sync-prefix>/IBF1/IBF2 \n content: /printer/1
+s1 -> s2: Sync interest: /<sync-prefix>/IBF2
+s1 -> d1: Callback, \n publish status
+
+note over s2
+Insert /printer/1
+to IBF1 and get IBF2
+end note
+s2 -> d2: Update callback \n to ndnsd
+note over s1,s2
+Send periodic sync interest
+end note
+@enduml

examples/consumer.cpp

@@ -1,13 +1,140 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c) 2014-2020,  The University of Memphis
+ *
+ * This file is part of NDNSD.
+ * Author: Saurab Dulal (sdulal@memphis.edu)
+ *
+ * NDNSD is free software: you can redistribute it and/or modify it under the terms
+ * of the GNU Lesser General Public License as published by the Free Software Foundation,
+ * either version 3 of the License, or (at your option) any later version.
+ *
+ * NDNSD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with
+ * NDNSD, e.g., in COPYING.md file.  If not, see <http://www.gnu.org/licenses/>.
+ **/
+
+#include "ndnsd/discovery/service-discovery.hpp"
+#include <ndn-cxx/util/logger.hpp>
 
 #include<iostream>
+#include <list>
+
+#include <boost/program_options/options_description.hpp>
+#include <boost/program_options/variables_map.hpp>
+#include <boost/program_options/parsers.hpp>
 
-class consumer 
+NDN_LOG_INIT(ndnsd.examples.ConsumerApp);
+
+static void
+usage(const boost::program_options::options_description& options)
 {
+  std::cout << "Usage: ndnsd-consumer [options] e.g. printer \n"
+            << options;
+   exit(2);
+}
 
-};
+class Consumer
+{
+public:
+  Consumer(const ndn::Name& serviceName, const std::map<char, uint8_t>& pFlags)
+   : m_serviceDiscovery(serviceName, pFlags, std::bind(&Consumer::processCallback, this, _1))
+  {
+  }
+
+  void
+  execute ()
+  {
+    // process and handle request
+    m_serviceDiscovery.consumerHandler();
+  }
+
+private:
+  void
+  processCallback(const ndnsd::discovery::Reply& callback)
+  {
+    NDN_LOG_INFO("Service info received");
+    auto status = (callback.status == ndnsd::discovery::ACTIVE)? "ACTIVE": "EXPIRED";
+    std::cout << "Status: " << status << std::endl;
+    for (const auto& item : callback.serviceDetails)
+    {
+      std::cout << item.first << ": " << item.second << std::endl;
+    }
+  }
+
+private:
+  ndnsd::discovery::ServiceDiscovery m_serviceDiscovery;
 
+};
 
-int main()
+int
+main(int argc, char* argv[])
 {
+  std::string serviceName;
+  int contFlag = -1;
+
+  namespace po = boost::program_options;
+  po::options_description visibleOptDesc("Options");
+
+  visibleOptDesc.add_options()
+    ("help,h",      "print this message and exit")
+    ("serviceName,s", po::value<std::string>(&serviceName)->required(), "Service name to fetch service info")
+    ("continuous,c", po::value<int>(&contFlag), "continuous discovery, 1 for true 0 for false")
+  ;
+
+  try
+  {
+    po::variables_map optVm;
+    po::store(po::parse_command_line(argc, argv, visibleOptDesc), optVm);
+    po::notify(optVm);
+
+    if (optVm.count("continuous")) {
+        if (contFlag != ndnsd::discovery::OPTIONAL and contFlag != ndnsd::discovery::REQUIRED) 
+        {
+          std::cout << "'c' must be either '0' or '1', default i.e. '0' will be used" << std::endl;
+        }
+      }
+    else
+      contFlag = 0;
+
+    if (optVm.count("serviceName")) {
+      if (serviceName.empty())
+      {
+        std::cerr << "ERROR: serviceName cannot be empty" << std::endl;
+        usage(visibleOptDesc);
+      }
+    }
+
+  }
+  catch (const po::error& e) {
+    std::cerr << "ERROR: " << e.what() << std::endl;
+    usage(visibleOptDesc);
+  }
+  // TODO: protocol shouldn't be hard-coded.
+  std::map<char, uint8_t> flags;
+  flags.insert(std::pair<char, uint8_t>('p', ndnsd::SYNC_PROTOCOL_PSYNC)); //protocol choice
+  flags.insert(std::pair<char, uint8_t>('t', ndnsd::discovery::CONSUMER)); //type producer: 1
+  flags.insert(std::pair<char, uint8_t>('c', contFlag));
+
+  try
+  {
+    std::cout << "Fetching service info for: " << serviceName << std::endl;
+    NDN_LOG_INFO("Fetching service info for: " << serviceName);
+    Consumer consumer(serviceName, flags);
+    consumer.execute();
+  }
+  catch (const std::exception& e) {
+    std::cerr << "ERROR: " << e.what() << std::endl;
+    NDN_LOG_ERROR("Cannot execute consumer, try again later: " << e.what());
+  }
 
+  try {
+    Consumer consumer(argv[1], flags);
+    consumer.execute();
+  }
+  catch (const std::exception& e) {
+  }
 }

examples/producer.cpp

@@ -0,0 +1,81 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c) 2014-2020,  The University of Memphis
+ *
+ * This file is part of NDNSD.
+ * Author: Saurab Dulal (sdulal@memphis.edu)
+ *
+ * NDNSD is free software: you can redistribute it and/or modify it under the terms
+ * of the GNU Lesser General Public License as published by the Free Software Foundation,
+ * either version 3 of the License, or (at your option) any later version.
+ *
+ * NDNSD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with
+ * NDNSD, e.g., in COPYING.md file.  If not, see <http://www.gnu.org/licenses/>.
+ **/
+
+#include "ndnsd/discovery/service-discovery.hpp"
+#include <ndn-cxx/util/logger.hpp>
+
+#include<iostream>
+#include <list>
+
+NDN_LOG_INIT(ndnsd.examples.ProducerApp);
+
+inline bool
+isFile(const std::string& fileName)
+{
+  return boost::filesystem::exists(fileName);
+}
+
+class Producer
+{
+public:
+
+  Producer(const std::string& filename, const std::map<char, uint8_t>& pFlags)
+    : m_serviceDiscovery(filename, pFlags, std::bind(&Producer::processCallback, this, _1))
+  {
+  }
+  void
+  execute ()
+  {
+    m_serviceDiscovery.producerHandler();
+  }
+
+private:
+  void
+  processCallback(const ndnsd::discovery::Reply& callback)
+  {
+    NDN_LOG_INFO("Service publish callback received");
+    auto status = (callback.status == ndnsd::discovery::ACTIVE)? "ACTIVE": "EXPIRED";
+    std::cout << "\n Status: " << status << std::endl;
+    for (auto& item : callback.serviceDetails)
+    {
+      std::cout << item.first << ": " << item.second << std::endl;
+    }
+  }
+
+private:
+  ndnsd::discovery::ServiceDiscovery m_serviceDiscovery;
+};
+
+int
+main(int argc, char* argv[])
+{
+  std::map<char, uint8_t> flags;
+  flags.insert(std::pair<char, uint8_t>('p', ndnsd::SYNC_PROTOCOL_PSYNC)); //protocol choice
+  flags.insert(std::pair<char, uint8_t>('t', ndnsd::discovery::PRODUCER)); //type producer: 1
+
+  try {
+    NDN_LOG_INFO("Starting producer application");
+    Producer producer(argv[1], flags);
+    producer.execute();
+  }
+  catch (const std::exception& e) {
+    std::cout << "Exception: " << e.what() << std::endl;
+    NDN_LOG_ERROR("Cannot execute producer, try again later: " << e.what());
+  }
+}

examples/wscript

@@ -0,0 +1,12 @@
+# -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-
+
+top = '..'
+
+def build(bld):
+    # List all .cpp files (whole example in one .cpp)
+    for ex in bld.path.ant_glob('*.cpp'):
+        name = ex.change_ext('').path_from(bld.path.get_bld())
+        bld.program(name='example-%s' % name,
+                    target='ndnsd-%s' % name,
+                    source=[ex],
+                    use='ndnsd')