data.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
#ifndef NDN_DATA_HPP
#define NDN_DATA_HPP

#include "common.hpp"
#include "name.hpp"
#include "encoding/block.hpp"

#include "signature.hpp"
#include "meta-info.hpp"
#include "key-locator.hpp"
#include "lp/tags.hpp"
#include "tag-host.hpp"

namespace ndn {

class Data : public TagHost, public enable_shared_from_this<Data>
{
public:
  class Error : public tlv::Error
  {
  public:
    explicit
    Error(const std::string& what)
      : tlv::Error(what)
    {
    }
  };

  Data();

  Data(const Name& name);

  explicit
  Data(const Block& wire);

  template<encoding::Tag TAG>
  size_t
  wireEncode(EncodingImpl<TAG>& encoder, bool wantUnsignedPortionOnly = false) const;

  const Block&
  wireEncode() const;

  const Block&
  wireEncode(EncodingBuffer& encoder, const Block& signatureValue) const;

  void
  wireDecode(const Block& wire);

  bool
  hasWire() const;


  const Name&
  getName() const;

  Data&
  setName(const Name& name);

  //

  const Name&
  getFullName() const;

  const MetaInfo&
  getMetaInfo() const;

  Data&
  setMetaInfo(const MetaInfo& metaInfo);

  //

  // MetaInfo proxy methods

  uint32_t
  getContentType() const;

  Data&
  setContentType(uint32_t type);

  //

  const time::milliseconds&
  getFreshnessPeriod() const;

  Data&
  setFreshnessPeriod(const time::milliseconds& freshnessPeriod);

  //

  const name::Component&
  getFinalBlockId() const;

  Data&
  setFinalBlockId(const name::Component& finalBlockId);

  //

  const Block&
  getContent() const;

  Data&
  setContent(const uint8_t* buffer, size_t bufferSize);

  Data&
  setContent(const Block& block);

  Data&
  setContent(const ConstBufferPtr& contentValue);

  //

  const Signature&
  getSignature() const;

  Data&
  setSignature(const Signature& signature);

  Data&
  setSignatureValue(const Block& value);


#ifdef NDN_LP_KEEP_LOCAL_CONTROL_HEADER

  DEPRECATED(
  lp::LocalControlHeaderFacade
  getLocalControlHeader());

  DEPRECATED(
  const lp::LocalControlHeaderFacade
  getLocalControlHeader() const);

  DEPRECATED(
  uint64_t
  getIncomingFaceId() const);

  DEPRECATED(
  Data&
  setIncomingFaceId(uint64_t incomingFaceId));

  DEPRECATED(
  lp::LocalControlHeaderFacade::CachingPolicy
  getCachingPolicy() const);

  DEPRECATED(
  Data&
  setCachingPolicy(lp::LocalControlHeaderFacade::CachingPolicy cachingPolicy));
#endif // NDN_LP_KEEP_LOCAL_CONTROL_HEADER

public: // EqualityComparable concept
  bool
  operator==(const Data& other) const;

  bool
  operator!=(const Data& other) const;

protected:
  void
  onChanged();

private:
  Name m_name;
  MetaInfo m_metaInfo;
  mutable Block m_content;
  Signature m_signature;

  mutable Block m_wire;
  mutable Name m_fullName;
};

std::ostream&
operator<<(std::ostream& os, const Data& data);

inline bool
Data::hasWire() const
{
  return m_wire.hasWire();
}

inline const Name&
Data::getName() const
{
  return m_name;
}

inline const MetaInfo&
Data::getMetaInfo() const
{
  return m_metaInfo;
}

inline uint32_t
Data::getContentType() const
{
  return m_metaInfo.getType();
}

inline const time::milliseconds&
Data::getFreshnessPeriod() const
{
  return m_metaInfo.getFreshnessPeriod();
}

inline const name::Component&
Data::getFinalBlockId() const
{
  return m_metaInfo.getFinalBlockId();
}

inline const Signature&
Data::getSignature() const
{
  return m_signature;
}

} // namespace ndn

#endif