src/communication/sync-logic-handler.hpp

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2024,  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_SYNC_LOGIC_HANDLER_HPP
#define NLSR_SYNC_LOGIC_HANDLER_HPP

#include "conf-parameter.hpp"
#include "lsa/lsa.hpp"
#include "signals.hpp"
#include "sync-protocol-adapter.hpp"
#include "test-access-control.hpp"

#include <boost/lexical_cast.hpp>

namespace nlsr {

struct SyncLogicOptions
{
  SyncProtocol syncProtocol;
  ndn::Name syncPrefix;
  ndn::Name userPrefix;
  ndn::time::milliseconds syncInterestLifetime;
  ndn::Name routerPrefix;
  HyperbolicState hyperbolicState;
};

inline ndn::Name
makeLsaUserPrefix(const ndn::Name& userPrefix, Lsa::Type lsaType)
{
  return ndn::Name(userPrefix).append(boost::lexical_cast<std::string>(lsaType));
}

/*! \brief NLSR-to-sync interaction point
 *
 * This class serves as the abstraction for the syncing portion of
 * NLSR and its components.
 */
class SyncLogicHandler
{
public:
  class Error : public std::runtime_error
  {
  public:
    using std::runtime_error::runtime_error;
  };

  using IsLsaNew = std::function<
    bool (const ndn::Name& routerName, Lsa::Type lsaType, uint64_t seqNo, uint64_t inFace)
  >;

  SyncLogicHandler(ndn::Face& face, ndn::KeyChain& keyChain,
                   IsLsaNew isLsaNew, const SyncLogicOptions& opts);

  /*! \brief Instruct ChronoSync to publish an update.
   *
   * This function instructs sync to push an update into the network,
   * based on whatever the state of the sequencing manager is when
   * this is called. Since each ChronoSync instance maintains its own
   * PIT, doing this satisfies those interests so that other routers
   * know a sync update is available.
   * \sa publishSyncUpdate
   */
  void
  publishRoutingUpdate(Lsa::Type type, uint64_t seqNo);

PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  /*! \brief Callback from Sync protocol
   *
   * In a typical situation this only needs to be called once, when NLSR starts.
   * \param updateName The prefix for which sync reports an update
   * \param highSeq The latest sequence number of the update
   */
  void
  processUpdate(const ndn::Name& updateName, uint64_t highSeq, uint64_t incomingFaceId);

  /*! \brief Determine which kind of LSA was updated and fetch it.
   *
   * Checks that the received update is not from us, which can happen,
   * and then inspects the update to determine which kind of LSA the
   * update is for. Finally, it expresses interest for the correct LSA
   * type.
   * \throws SyncUpdate::Error If the sync update doesn't look like a sync LSA update.
   */
  void
  processUpdateFromSync(const ndn::Name& originRouter,
                        const ndn::Name& updateName, uint64_t seqNo, uint64_t incomingFaceId);

public:
  OnNewLsa onNewLsa;

private:
  IsLsaNew m_isLsaNew;
  ndn::Name m_routerPrefix;
  HyperbolicState m_hyperbolicState;

PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  ndn::Name m_nameLsaUserPrefix;
  ndn::Name m_adjLsaUserPrefix;
  ndn::Name m_coorLsaUserPrefix;

  SyncProtocolAdapter m_syncLogic;
};

} // namespace nlsr

#endif // NLSR_SYNC_LOGIC_HANDLER_HPP