prefix-announcement-header.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2022 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_LP_PREFIX_ANNOUNCEMENT_HEADER_HPP
23 #define NDN_CXX_LP_PREFIX_ANNOUNCEMENT_HEADER_HPP
24 
26 
27 namespace ndn {
28 namespace lp {
29 
33 {
34 public:
35  class Error : public ndn::tlv::Error
36  {
37  public:
39  };
40 
42 
43  explicit
44  PrefixAnnouncementHeader(const Block& block);
45 
50  explicit
52 
57  template<encoding::Tag TAG>
58  size_t
59  wireEncode(EncodingImpl<TAG>& encoder) const;
60 
61  void
62  wireDecode(const Block& wire);
63 
64  const optional<PrefixAnnouncement>&
65  getPrefixAnn() const
66  {
67  return m_prefixAnn;
68  }
69 
70 private:
71  optional<PrefixAnnouncement> m_prefixAnn;
72 };
73 
74 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(PrefixAnnouncementHeader);
75 
76 } // namespace lp
77 } // namespace ndn
78 
79 #endif // NDN_CXX_LP_PREFIX_ANNOUNCEMENT_HEADER_HPP
Represents a TLV element of the NDN packet format.
Definition: block.hpp:45
A prefix announcement object that represents an application's intent of registering a prefix toward i...
Represents a PrefixAnnouncement header field in NDNLP.
const optional< PrefixAnnouncement > & getPrefixAnn() const
size_t wireEncode(EncodingImpl< TAG > &encoder) const
Encodes the prefix announcement header to the wire format.
Represents an error in TLV encoding or decoding.
Definition: tlv.hpp:54
Error(const char *expectedType, uint32_t actualType)
Definition: tlv.cpp:27
#define NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(ClassName)
Definition: data.cpp:25