blob: e30f9d7d34ec155abd2530552543f8bc2e481fcf [file] [log] [blame]
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
* Copyright (c) 2014 Regents of the University of California,
* Arizona Board of Regents,
* Colorado State University,
* University Pierre & Marie Curie, Sorbonne University,
* Washington University in St. Louis,
* Beijing Institute of Technology
*
* This file is part of NFD (Named Data Networking Forwarding Daemon).
* See AUTHORS.md for complete list of NFD authors and contributors.
*
* NFD 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.
*
* NFD 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
* NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
**/
#ifndef NFD_TABLE_FIB_ENTRY_HPP
#define NFD_TABLE_FIB_ENTRY_HPP
#include "fib-nexthop.hpp"
namespace nfd {
class NameTree;
namespace name_tree {
class Entry;
}
namespace fib {
/** \class NextHopList
* \brief represents a collection of nexthops
* This type has these methods:
* iterator<NextHop> begin()
* iterator<NextHop> end()
* size_t size()
*/
typedef std::vector<fib::NextHop> NextHopList;
/** \class Entry
* \brief represents a FIB entry
*/
class Entry : noncopyable
{
public:
explicit
Entry(const Name& prefix);
const Name&
getPrefix() const;
const NextHopList&
getNextHops() const;
/// whether this Entry has any nexthop
bool
hasNextHops() const;
bool
hasNextHop(shared_ptr<Face> face) const;
/// adds a nexthop
void
addNextHop(shared_ptr<Face> face, uint64_t cost);
/// removes a nexthop
void
removeNextHop(shared_ptr<Face> face);
private:
/// sorts the nexthop list
void
sortNextHops();
private:
Name m_prefix;
NextHopList m_nextHops;
shared_ptr<name_tree::Entry> m_nameTreeEntry;
friend class nfd::NameTree;
friend class nfd::name_tree::Entry;
};
inline const Name&
Entry::getPrefix() const
{
return m_prefix;
}
inline const NextHopList&
Entry::getNextHops() const
{
return m_nextHops;
}
inline bool
Entry::hasNextHops() const
{
return !m_nextHops.empty();
}
} // namespace fib
} // namespace nfd
#endif // NFD_TABLE_FIB_ENTRY_HPP