meta-info.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2024 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_META_INFO_HPP
#define NDN_CXX_META_INFO_HPP
 
#include "ndn-cxx/name-component.hpp"
#include "ndn-cxx/encoding/block.hpp"
#include "ndn-cxx/encoding/encoding-buffer.hpp"
#include "ndn-cxx/util/time.hpp"
 
#include <list>
#include <optional>
 
namespace ndn {
 
inline constexpr time::milliseconds DEFAULT_FRESHNESS_PERIOD = 0_ms;
 
class MetaInfo
{
public:
  class Error : public tlv::Error
  {
  public:
    using tlv::Error::Error;
  };
 
  MetaInfo();
 
  explicit
  MetaInfo(const Block& block);
 
  template<encoding::Tag TAG>
  size_t
  wireEncode(EncodingImpl<TAG>& encoder) const;
 
  const Block&
  wireEncode() const;
 
  void
  wireDecode(const Block& wire);
 
public: // getter/setter
  uint32_t
  getType() const noexcept
  {
    return m_type;
  }
 
  MetaInfo&
  setType(uint32_t type);
 
  time::milliseconds
  getFreshnessPeriod() const noexcept;
 
  MetaInfo&
  setFreshnessPeriod(time::milliseconds freshnessPeriod);
 
  const std::optional<name::Component>&
  getFinalBlock() const noexcept
  {
    return m_finalBlockId;
  }
 
  MetaInfo&
  setFinalBlock(std::optional<name::Component> finalBlockId);
 
public: // app-defined MetaInfo items
  const std::list<Block>&
  getAppMetaInfo() const;
 
  MetaInfo&
  setAppMetaInfo(const std::list<Block>& info);
 
  MetaInfo&
  addAppMetaInfo(const Block& block);
 
  bool
  removeAppMetaInfo(uint32_t tlvType);
 
  const Block*
  findAppMetaInfo(uint32_t tlvType) const;
 
private:
  uint32_t m_type = tlv::ContentType_Blob;
  uint64_t m_freshnessPeriod = DEFAULT_FRESHNESS_PERIOD.count();
  std::optional<name::Component> m_finalBlockId;
  std::list<Block> m_appMetaInfo;
 
  mutable Block m_wire;
};
 
NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(MetaInfo);
 
std::ostream&
operator<<(std::ostream& os, const MetaInfo& info);
 
} // namespace ndn
 
#endif // NDN_CXX_META_INFO_HPP