tag-host.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2024 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
22 #ifndef NDN_CXX_DETAIL_TAG_HOST_HPP
23 #define NDN_CXX_DETAIL_TAG_HOST_HPP
24 
25 #include "ndn-cxx/tag.hpp"
26 
27 #include <map>
28 #include <memory>
29 #include <type_traits>
30 
31 namespace ndn {
32 
36 class TagHost
37 {
38 public:
44  template<typename T>
45  std::shared_ptr<T>
46  getTag() const;
47 
53  template<typename T>
54  void
55  setTag(std::shared_ptr<T> tag) const;
56 
62  template<typename T>
63  void
64  removeTag() const;
65 
66 private:
67  mutable std::map<int, std::shared_ptr<Tag>> m_tags;
68 };
69 
70 template<typename T>
71 std::shared_ptr<T>
73 {
74  static_assert(std::is_convertible_v<T*, Tag*>, "T must inherit from ndn::Tag");
75 
76  if (auto it = m_tags.find(T::getTypeId()); it != m_tags.end()) {
77  return std::static_pointer_cast<T>(it->second);
78  }
79  return nullptr;
80 }
81 
82 template<typename T>
83 void
84 TagHost::setTag(std::shared_ptr<T> tag) const
85 {
86  static_assert(std::is_convertible_v<T*, Tag*>, "T must inherit from ndn::Tag");
87 
88  if (tag == nullptr) {
89  m_tags.erase(T::getTypeId());
90  }
91  else {
92  m_tags[T::getTypeId()] = std::move(tag);
93  }
94 }
95 
96 template<typename T>
97 void
99 {
100  setTag<T>(nullptr);
101 }
102 
103 } // namespace ndn
104 
105 #endif // NDN_CXX_DETAIL_TAG_HOST_HPP
Base class to store tag information, e.g., inside Interest and Data packets.
Definition: tag-host.hpp:37
void removeTag() const
Remove a tag item.
Definition: tag-host.hpp:98
std::shared_ptr< T > getTag() const
Get a tag item.
Definition: tag-host.hpp:72
void setTag(std::shared_ptr< T > tag) const
Set (add or replace) a tag item.
Definition: tag-host.hpp:84
Definition: data.cpp:25