examples: add library usage examples
refs: #4793
Change-Id: I660ed74bca55debd885b4cdefb230225ccdfe4ca
diff --git a/examples/full-sync.cpp b/examples/full-sync.cpp
new file mode 100644
index 0000000..56adaf0
--- /dev/null
+++ b/examples/full-sync.cpp
@@ -0,0 +1,128 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c) 2014-2019, The University of Memphis
+ *
+ * This file is part of PSync.
+ * See AUTHORS.md for complete list of PSync authors and contributors.
+ *
+ * PSync is free software: you can redistribute it and/or modify it under the terms
+ * of the GNU General Public License as published by the Free Software Foundation,
+ * either version 3 of the License, or (at your option) any later version.
+ *
+ * PSync 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * PSync, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
+ **/
+
+#include <PSync/full-producer.hpp>
+
+#include <ndn-cxx/util/logger.hpp>
+#include <ndn-cxx/util/random.hpp>
+
+#include <iostream>
+
+NDN_LOG_INIT(examples.FullSyncApp);
+
+using namespace ndn::time_literals;
+
+class Producer
+{
+public:
+ /**
+ * @brief Initialize producer and schedule updates
+ *
+ * Set IBF size as 80 expecting 80 updates to IBF in a sync cycle
+ * Set syncInterestLifetime and syncReplyFreshness to 1.6 seconds
+ * userPrefix is the default user prefix, no updates are published on it in this example
+ */
+ Producer(const ndn::Name& syncPrefix, const std::string& userPrefix,
+ int numDataStreams, int maxNumPublish)
+ : m_scheduler(m_face.getIoService())
+ , m_fullProducer(80, m_face, syncPrefix, userPrefix,
+ std::bind(&Producer::processSyncUpdate, this, _1),
+ 1600_ms, 1600_ms)
+ , m_numDataStreams(numDataStreams)
+ , m_maxNumPublish(maxNumPublish)
+ , m_rng(ndn::random::getRandomNumberEngine())
+ , m_rangeUniformRandom(0, 60000)
+ {
+ // Add user prefixes and schedule updates for them in specified interval
+ for (int i = 0; i < m_numDataStreams; i++) {
+ ndn::Name prefix(userPrefix + "-" + ndn::to_string(i));
+
+ m_fullProducer.addUserNode(prefix);
+
+ m_scheduler.scheduleEvent(ndn::time::milliseconds(m_rangeUniformRandom(m_rng)),
+ [this, prefix] {
+ doUpdate(prefix);
+ });
+ }
+ }
+
+ void
+ run()
+ {
+ m_face.processEvents();
+ }
+
+private:
+ void
+ doUpdate(const ndn::Name& prefix)
+ {
+ m_fullProducer.publishName(prefix);
+
+ uint64_t seqNo = m_fullProducer.getSeqNo(prefix).value();
+ NDN_LOG_INFO("Publish: " << prefix << "/" << seqNo);
+
+ if (seqNo < m_maxNumPublish) {
+ m_scheduler.scheduleEvent(ndn::time::milliseconds(m_rangeUniformRandom(m_rng)),
+ [this, prefix] {
+ doUpdate(prefix);
+ });
+ }
+ }
+
+ void
+ processSyncUpdate(const std::vector<psync::MissingDataInfo>& updates)
+ {
+ for (const auto& update : updates) {
+ for (uint64_t i = update.lowSeq; i <= update.highSeq; i++) {
+ NDN_LOG_INFO("Update " << update.prefix << "/" << i);
+ }
+ }
+ }
+
+private:
+ ndn::Face m_face;
+ ndn::util::Scheduler m_scheduler;
+
+ psync::FullProducer m_fullProducer;
+
+ int m_numDataStreams;
+ uint64_t m_maxNumPublish;
+
+ ndn::random::RandomNumberEngine& m_rng;
+ std::uniform_int_distribution<> m_rangeUniformRandom;
+};
+
+int
+main(int argc, char* argv[])
+{
+ if (argc != 5) {
+ std::cout << "usage: " << argv[0] << " <syncPrefix> <user-prefix> "
+ << "<number-of-user-prefixes> <max-number-of-updates-per-user-prefix>"
+ << std::endl;
+ return 1;
+ }
+
+ try {
+ Producer producer(argv[1], argv[2], std::stoi(argv[3]), std::stoi(argv[4]));
+ producer.run();
+ }
+ catch (const std::exception& e) {
+ NDN_LOG_ERROR(e.what());
+ }
+}