akmhoque | 3d06e79 | 2014-05-27 16:23:20 -0500 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
| 2 | /** |
Nick Gordon | c6a8522 | 2017-01-03 16:54:34 -0600 | [diff] [blame] | 3 | * Copyright (c) 2014-2017, The University of Memphis, |
alvy | 297f416 | 2015-03-03 17:15:33 -0600 | [diff] [blame] | 4 | * Regents of the University of California, |
| 5 | * Arizona Board of Regents. |
akmhoque | 3d06e79 | 2014-05-27 16:23:20 -0500 | [diff] [blame] | 6 | * |
| 7 | * This file is part of NLSR (Named-data Link State Routing). |
| 8 | * See AUTHORS.md for complete list of NLSR authors and contributors. |
| 9 | * |
| 10 | * NLSR is free software: you can redistribute it and/or modify it under the terms |
| 11 | * of the GNU General Public License as published by the Free Software Foundation, |
| 12 | * either version 3 of the License, or (at your option) any later version. |
| 13 | * |
| 14 | * NLSR is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; |
| 15 | * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR |
| 16 | * PURPOSE. See the GNU General Public License for more details. |
| 17 | * |
| 18 | * You should have received a copy of the GNU General Public License along with |
| 19 | * NLSR, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>. |
akmhoque | 3d06e79 | 2014-05-27 16:23:20 -0500 | [diff] [blame] | 20 | **/ |
alvy | 297f416 | 2015-03-03 17:15:33 -0600 | [diff] [blame] | 21 | |
akmhoque | fdbddb1 | 2014-05-02 18:35:19 -0500 | [diff] [blame] | 22 | #ifndef NLSR_NAME_PREFIX_LIST_HPP |
| 23 | #define NLSR_NAME_PREFIX_LIST_HPP |
akmhoque | 5335346 | 2014-04-22 08:43:45 -0500 | [diff] [blame] | 24 | |
| 25 | #include <list> |
| 26 | #include <string> |
akmhoque | fdbddb1 | 2014-05-02 18:35:19 -0500 | [diff] [blame] | 27 | #include <boost/cstdint.hpp> |
akmhoque | 31d1d4b | 2014-05-05 22:08:14 -0500 | [diff] [blame] | 28 | #include <ndn-cxx/name.hpp> |
akmhoque | c8a10f7 | 2014-04-25 18:42:55 -0500 | [diff] [blame] | 29 | |
akmhoque | 5335346 | 2014-04-22 08:43:45 -0500 | [diff] [blame] | 30 | |
| 31 | namespace nlsr { |
akmhoque | c8a10f7 | 2014-04-25 18:42:55 -0500 | [diff] [blame] | 32 | class NamePrefixList |
akmhoque | 5335346 | 2014-04-22 08:43:45 -0500 | [diff] [blame] | 33 | { |
akmhoque | 5335346 | 2014-04-22 08:43:45 -0500 | [diff] [blame] | 34 | public: |
Nick Gordon | f14ec35 | 2017-07-24 16:09:58 -0500 | [diff] [blame^] | 35 | using NamePair = std::tuple<ndn::Name, std::vector<std::string>>; |
| 36 | enum NamePairIndex { |
| 37 | NAME, |
| 38 | SOURCES |
| 39 | }; |
| 40 | |
akmhoque | c8a10f7 | 2014-04-25 18:42:55 -0500 | [diff] [blame] | 41 | NamePrefixList(); |
akmhoque | 5335346 | 2014-04-22 08:43:45 -0500 | [diff] [blame] | 42 | |
akmhoque | c8a10f7 | 2014-04-25 18:42:55 -0500 | [diff] [blame] | 43 | ~NamePrefixList(); |
akmhoque | 5335346 | 2014-04-22 08:43:45 -0500 | [diff] [blame] | 44 | |
Nick G | 97e3494 | 2016-07-11 14:46:27 -0500 | [diff] [blame] | 45 | /*! \brief inserts name into NamePrefixList |
| 46 | \retval true If the name was successfully inserted. |
| 47 | \retval false If the name could not be inserted. |
alvy | 297f416 | 2015-03-03 17:15:33 -0600 | [diff] [blame] | 48 | */ |
| 49 | bool |
Nick Gordon | f14ec35 | 2017-07-24 16:09:58 -0500 | [diff] [blame^] | 50 | insert(const ndn::Name& name, const std::string& source = ""); |
akmhoque | 5335346 | 2014-04-22 08:43:45 -0500 | [diff] [blame] | 51 | |
Nick G | 97e3494 | 2016-07-11 14:46:27 -0500 | [diff] [blame] | 52 | /*! \brief removes name from NamePrefixList |
| 53 | \retval true If the name is removed |
| 54 | \retval false If the name failed to be removed. |
alvy | 297f416 | 2015-03-03 17:15:33 -0600 | [diff] [blame] | 55 | */ |
| 56 | bool |
Nick Gordon | f14ec35 | 2017-07-24 16:09:58 -0500 | [diff] [blame^] | 57 | remove(const ndn::Name& name, const std::string& source = ""); |
akmhoque | 5335346 | 2014-04-22 08:43:45 -0500 | [diff] [blame] | 58 | |
| 59 | void |
| 60 | sort(); |
| 61 | |
akmhoque | 31d1d4b | 2014-05-05 22:08:14 -0500 | [diff] [blame] | 62 | size_t |
akmhoque | 5335346 | 2014-04-22 08:43:45 -0500 | [diff] [blame] | 63 | getSize() |
| 64 | { |
Nick Gordon | f14ec35 | 2017-07-24 16:09:58 -0500 | [diff] [blame^] | 65 | return m_names.size(); |
akmhoque | 5335346 | 2014-04-22 08:43:45 -0500 | [diff] [blame] | 66 | } |
| 67 | |
Nick Gordon | f14ec35 | 2017-07-24 16:09:58 -0500 | [diff] [blame^] | 68 | std::list<ndn::Name> |
| 69 | getNames() const; |
Nick Gordon | 56d1fae | 2017-05-26 16:39:25 -0500 | [diff] [blame] | 70 | |
| 71 | bool |
| 72 | operator==(const NamePrefixList& other) const; |
| 73 | |
Nick Gordon | f14ec35 | 2017-07-24 16:09:58 -0500 | [diff] [blame^] | 74 | /*! Returns how many unique sources this name has. |
akmhoque | 5335346 | 2014-04-22 08:43:45 -0500 | [diff] [blame] | 75 | |
Nick Gordon | f14ec35 | 2017-07-24 16:09:58 -0500 | [diff] [blame^] | 76 | \retval 0 if the name is not in the list, else the number of sources. |
| 77 | */ |
| 78 | uint32_t |
| 79 | countSources(const ndn::Name& name) const; |
| 80 | |
| 81 | /*! Returns the sources that this name has. |
| 82 | |
| 83 | \retval an empty vector if the name is not in the list, else a |
| 84 | vector containing the sources. |
| 85 | */ |
| 86 | const std::vector<std::string> |
| 87 | getSources(const ndn::Name& name) const; |
| 88 | |
| 89 | private: |
| 90 | /*! Obtain an iterator to the entry matching name. |
| 91 | |
| 92 | \note We could do this quite easily inline with a lambda, but this |
| 93 | is slightly more efficient. |
| 94 | */ |
| 95 | std::vector<NamePair>::iterator |
| 96 | get(const ndn::Name& name); |
| 97 | |
| 98 | /*! Obtain an iterator to a specific source in an entry |
| 99 | */ |
| 100 | std::vector<std::string>::iterator |
| 101 | getSource(const std::string& source, std::vector<NamePair>::iterator& entry); |
| 102 | |
| 103 | std::vector<NamePair> m_names; |
akmhoque | 5335346 | 2014-04-22 08:43:45 -0500 | [diff] [blame] | 104 | }; |
| 105 | |
Nick Gordon | 56d1fae | 2017-05-26 16:39:25 -0500 | [diff] [blame] | 106 | std::ostream& |
| 107 | operator<<(std::ostream& os, const NamePrefixList& list); |
| 108 | |
Nick Gordon | fad8e25 | 2016-08-11 14:21:38 -0500 | [diff] [blame] | 109 | } // namespace nlsr |
akmhoque | 5335346 | 2014-04-22 08:43:45 -0500 | [diff] [blame] | 110 | |
Nick Gordon | 56d1fae | 2017-05-26 16:39:25 -0500 | [diff] [blame] | 111 | #endif // NLSR_NAME_PREFIX_LIST_HPP |