hello-protocol.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2023,  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/>.
 */
 
#ifndef NLSR_HELLO_PROTOCOL_HPP
#define NLSR_HELLO_PROTOCOL_HPP
 
#include "conf-parameter.hpp"
#include "lsdb.hpp"
#include "route/routing-table.hpp"
#include "statistics.hpp"
#include "test-access-control.hpp"
 
#include <ndn-cxx/face.hpp>
#include <ndn-cxx/security/validation-error.hpp>
#include <ndn-cxx/util/scheduler.hpp>
#include <ndn-cxx/util/signal.hpp>
 
namespace nlsr {
 
class HelloProtocol
{
public:
  HelloProtocol(ndn::Face& face, ndn::KeyChain& keyChain, ConfParameter& confParam,
                RoutingTable& routingTable, Lsdb& lsdb);
 
  void
  expressInterest(const ndn::Name& interestNamePrefix, uint32_t seconds);
 
  void
  sendHelloInterest(const ndn::Name& neighbor);
 
  void
  processInterest(const ndn::Name& name, const ndn::Interest& interest);
 
  ndn::signal::Signal<HelloProtocol, Statistics::PacketType> hpIncrementSignal;
 
private:
  void
  processInterestTimedOut(const ndn::Interest& interest);
 
  void
  onContent(const ndn::Interest& interest, const ndn::Data& data);
 
PUBLIC_WITH_TESTS_ELSE_PRIVATE:
 
  void
  onContentValidated(const ndn::Data& data);
 
private:
  void
  onContentValidationFailed(const ndn::Data& data,
                            const ndn::security::ValidationError& ve);
 
public:
  static inline const std::string INFO_COMPONENT{"INFO"};
  static inline const std::string NLSR_COMPONENT{"nlsr"};
 
  ndn::signal::Signal<HelloProtocol, const ndn::Name&> onInitialHelloDataValidated;
 
private:
  ndn::Face& m_face;
  ndn::Scheduler m_scheduler;
  ndn::security::KeyChain& m_keyChain;
  const ndn::security::SigningInfo& m_signingInfo;
  ConfParameter& m_confParam;
  RoutingTable& m_routingTable;
  Lsdb& m_lsdb;
  AdjacencyList& m_adjacencyList;
};
 
} // namespace nlsr
 
#endif // NLSR_HELLO_PROTOCOL_HPP