metadata-object.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2021 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.
 *
 * @author Chavoosh Ghasemi <chghasemi@cs.arizona.edu>
 */

#ifndef NDN_CXX_METADATA_OBJECT_HPP
#define NDN_CXX_METADATA_OBJECT_HPP

#include "ndn-cxx/data.hpp"
#include "ndn-cxx/interest.hpp"
#include "ndn-cxx/security/key-chain.hpp"

namespace ndn {

class MetadataObject
{
public:
  class Error : public tlv::Error
  {
  public:
    using tlv::Error::Error;
  };

  MetadataObject();

  explicit
  MetadataObject(const Data& data);

  NDN_CXX_NODISCARD Data
  makeData(Name discoveryInterestName,
           KeyChain& keyChain,
           const ndn::security::SigningInfo& si = security::SigningInfo(),
           optional<uint64_t> version = nullopt,
           time::milliseconds freshnessPeriod = 10_ms) const;

  const Name&
  getVersionedName() const
  {
    return m_versionedName;
  }

  MetadataObject&
  setVersionedName(const Name& name);

public: // static methods
  static const name::Component&
  getKeywordComponent();

  static bool
  isValidName(const Name& name);

  NDN_CXX_NODISCARD static Interest
  makeDiscoveryInterest(Name name);

private:
  Name m_versionedName;
};

} // namespace ndn

#endif // NDN_CXX_METADATA_OBJECT_HPP