prefix-announcement.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2023 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_PREFIX_ANNOUNCEMENT_HPP
#define NDN_CXX_PREFIX_ANNOUNCEMENT_HPP
 
#include "ndn-cxx/data.hpp"
#include "ndn-cxx/security/key-chain.hpp"
 
namespace ndn {
 
class PrefixAnnouncement : private boost::equality_comparable<PrefixAnnouncement>
{
public:
  class Error : public tlv::Error
  {
  public:
    using tlv::Error::Error;
  };
 
  PrefixAnnouncement();
 
  explicit
  PrefixAnnouncement(Data data);
 
  const std::optional<Data>&
  getData() const
  {
    return m_data;
  }
 
  const Data&
  toData(KeyChain& keyChain,
         const ndn::security::SigningInfo& si = security::SigningInfo(),
         std::optional<uint64_t> version = std::nullopt) const;
 
  const Name&
  getAnnouncedName() const
  {
    return m_announcedName;
  }
 
  PrefixAnnouncement&
  setAnnouncedName(Name name);
 
  time::milliseconds
  getExpiration() const
  {
    return m_expiration;
  }
 
  PrefixAnnouncement&
  setExpiration(time::milliseconds expiration);
 
  std::optional<security::ValidityPeriod>
  getValidityPeriod() const
  {
    return m_validity;
  }
 
  PrefixAnnouncement&
  setValidityPeriod(std::optional<security::ValidityPeriod> validity);
 
public: // static methods
  static const name::Component&
  getKeywordComponent();
 
private: // non-member operators
  // NOTE: the following "hidden friend" operators are available via
  //       argument-dependent lookup only and must be defined inline.
  // boost::equality_comparable provides != operator.
 
  friend bool
  operator==(const PrefixAnnouncement& lhs, const PrefixAnnouncement& rhs)
  {
    return lhs.m_announcedName == rhs.m_announcedName &&
           lhs.m_expiration == rhs.m_expiration &&
           lhs.m_validity == rhs.m_validity;
  }
 
private:
  Name m_announcedName;
  time::milliseconds m_expiration = 0_ms;
  std::optional<security::ValidityPeriod> m_validity;
 
  mutable std::optional<Data> m_data;
};
 
std::ostream&
operator<<(std::ostream& os, const PrefixAnnouncement& pa);
 
} // namespace ndn
 
#endif // NDN_CXX_PREFIX_ANNOUNCEMENT_HPP