rib-entry.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2023 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library 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.
 *
 * ndn-cxx library 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 copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */
 
#ifndef NDN_CXX_MGMT_NFD_RIB_ENTRY_HPP
#define NDN_CXX_MGMT_NFD_RIB_ENTRY_HPP
 
#include "ndn-cxx/encoding/nfd-constants.hpp"
#include "ndn-cxx/mgmt/nfd/route-flags-traits.hpp"
#include "ndn-cxx/name.hpp"
#include "ndn-cxx/util/time.hpp"
 
namespace ndn::nfd {
 
class Route : public RouteFlagsTraits<Route>
{
public:
  class Error : public tlv::Error
  {
  public:
    using tlv::Error::Error;
  };
 
  Route();
 
  explicit
  Route(const Block& block);
 
  uint64_t
  getFaceId() const
  {
    return m_faceId;
  }
 
  Route&
  setFaceId(uint64_t faceId);
 
  RouteOrigin
  getOrigin() const
  {
    return m_origin;
  }
 
  Route&
  setOrigin(RouteOrigin origin);
 
  uint64_t
  getCost() const
  {
    return m_cost;
  }
 
  Route&
  setCost(uint64_t cost);
 
  uint64_t
  getFlags() const
  {
    return m_flags;
  }
 
  Route&
  setFlags(uint64_t flags);
 
  bool
  hasExpirationPeriod() const
  {
    return !!m_expirationPeriod;
  }
 
  time::milliseconds
  getExpirationPeriod() const
  {
    return m_expirationPeriod ? *m_expirationPeriod : time::milliseconds::max();
  }
 
  Route&
  setExpirationPeriod(time::milliseconds expirationPeriod);
 
  Route&
  unsetExpirationPeriod();
 
  template<encoding::Tag TAG>
  size_t
  wireEncode(EncodingImpl<TAG>& block) const;
 
  const Block&
  wireEncode() const;
 
  void
  wireDecode(const Block& block);
 
private:
  uint64_t m_faceId = INVALID_FACE_ID;
  RouteOrigin m_origin = ROUTE_ORIGIN_APP;
  uint64_t m_cost = 0;
  uint64_t m_flags = ROUTE_FLAG_CHILD_INHERIT;
  std::optional<time::milliseconds> m_expirationPeriod;
 
  mutable Block m_wire;
};
 
NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(Route);
 
bool
operator==(const Route& a, const Route& b);
 
inline bool
operator!=(const Route& a, const Route& b)
{
  return !(a == b);
}
 
std::ostream&
operator<<(std::ostream& os, const Route& route);
 
 
class RibEntry
{
public:
  class Error : public tlv::Error
  {
  public:
    using tlv::Error::Error;
  };
 
  RibEntry();
 
  explicit
  RibEntry(const Block& block);
 
  const Name&
  getName() const
  {
    return m_prefix;
  }
 
  RibEntry&
  setName(const Name& prefix);
 
  const std::vector<Route>&
  getRoutes() const
  {
    return m_routes;
  }
 
  template<typename InputIt>
  RibEntry&
  setRoutes(InputIt first, InputIt last)
  {
    m_routes.assign(first, last);
    m_wire.reset();
    return *this;
  }
 
  RibEntry&
  addRoute(const Route& route);
 
  RibEntry&
  clearRoutes();
 
  template<encoding::Tag TAG>
  size_t
  wireEncode(EncodingImpl<TAG>& block) const;
 
  const Block&
  wireEncode() const;
 
  void
  wireDecode(const Block& block);
 
private:
  Name m_prefix;
  std::vector<Route> m_routes;
 
  mutable Block m_wire;
};
 
NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(RibEntry);
 
bool
operator==(const RibEntry& a, const RibEntry& b);
 
inline bool
operator!=(const RibEntry& a, const RibEntry& b)
{
  return !(a == b);
}
 
std::ostream&
operator<<(std::ostream& os, const RibEntry& entry);
 
} // namespace ndn::nfd
 
#endif // NDN_CXX_MGMT_NFD_RIB_ENTRY_HPP