tools: Add nlsrc command line tool
refs: #1834
Change-Id: Ifbe75a3f49e2689930e61ebfd348d9932b04c975
diff --git a/tools/nlsrc.hpp b/tools/nlsrc.hpp
new file mode 100644
index 0000000..b62cca0
--- /dev/null
+++ b/tools/nlsrc.hpp
@@ -0,0 +1,162 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/**
+ * Copyright (c) 2014-2015, The University of Memphis,
+ * Regents of the University of California,
+ * Arizona Board of Regents.
+ *
+ * This file is part of NLSR (Named-data Link State Routing).
+ * See AUTHORS.md for complete list of NLSR authors and contributors.
+ *
+ * NLSR 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.
+ *
+ * NLSR 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
+ * NLSR, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
+ **/
+
+#include "tlv/adjacency-lsa.hpp"
+#include "tlv/coordinate-lsa.hpp"
+#include "tlv/name-lsa.hpp"
+
+#include <boost/noncopyable.hpp>
+#include <ndn-cxx/face.hpp>
+#include <ndn-cxx/security/key-chain.hpp>
+
+#include <deque>
+#include <map>
+#include <stdexcept>
+
+#ifndef NLSR_TOOLS_NLSRC_HPP
+#define NLSR_TOOLS_NLSRC_HPP
+
+namespace nlsrc {
+
+class Nlsrc : boost::noncopyable
+{
+public:
+ explicit
+ Nlsrc(ndn::Face& face);
+
+ void
+ printUsage();
+
+ void
+ getStatus();
+
+ bool
+ dispatch(const std::string& cmd);
+
+private:
+ void
+ runNextStep();
+
+ /**
+ * \brief Adds a name prefix to be advertised in NLSR's Name LSA
+ *
+ * cmd format:
+ * name
+ *
+ */
+ void
+ advertiseName();
+
+ /**
+ * \brief Removes a name prefix from NLSR's Name LSA
+ *
+ * cmd format:
+ * name
+ *
+ */
+ void
+ withdrawName();
+
+ void
+ sendNamePrefixUpdate(const ndn::Name& name,
+ const ndn::Name::Component& verb,
+ const std::string& info);
+
+ void
+ onControlResponse(const std::string& info, const ndn::Data& data);
+
+private:
+ void
+ fetchAdjacencyLsas();
+
+ void
+ fetchCoordinateLsas();
+
+ void
+ fetchNameLsas();
+
+ template <class T>
+ void
+ fetchFromLsdb(const ndn::Name::Component& datasetType,
+ const std::function<void(const T&)>& recordLsa);
+
+ template <class T>
+ void
+ onFetchSuccess(const ndn::ConstBufferPtr& data,
+ const std::function<void(const T&)>& recordLsa);
+
+ void
+ onTimeout(uint32_t errorCode, const std::string& error);
+
+private:
+ std::string
+ getLsaInfoString(const nlsr::tlv::LsaInfo& info);
+
+ void
+ recordAdjacencyLsa(const nlsr::tlv::AdjacencyLsa& lsa);
+
+ void
+ recordCoordinateLsa(const nlsr::tlv::CoordinateLsa& lsa);
+
+ void
+ recordNameLsa(const nlsr::tlv::NameLsa& lsa);
+
+ void
+ printLsdb();
+
+public:
+ const char* programName;
+
+ // command parameters without leading 'cmd' component
+ const char* const* commandLineArguments;
+ int nOptions;
+
+private:
+ struct Router
+ {
+ std::string adjacencyLsaString;
+ std::string coordinateLsaString;
+ std::string nameLsaString;
+ };
+
+ Router&
+ getRouter(const nlsr::tlv::LsaInfo& info);
+
+ typedef std::map<const ndn::Name, Router> RouterMap;
+ RouterMap m_routers;
+
+private:
+ ndn::KeyChain m_keyChain;
+ ndn::Face& m_face;
+
+ std::deque<std::function<void()>> m_fetchSteps;
+
+ static const ndn::Name LOCALHOST_PREFIX;
+ static const ndn::Name LSDB_PREFIX;
+ static const ndn::Name NAME_UPDATE_PREFIX;
+
+ static const uint32_t ERROR_CODE_TIMEOUT;
+ static const uint32_t RESPONSE_CODE_SUCCESS;
+};
+
+} // namespace nlsrc
+
+#endif // NLSR_TOOLS_NLSRC_HPP