interest.hpp

Go to the documentation of this file.

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

#include "common.hpp"

#include "name.hpp"
#include "selectors.hpp"
#include "util/time.hpp"
#include "lp/tags.hpp"
#include "tag-host.hpp"
#include "link.hpp"

namespace ndn {

class Data;

const time::milliseconds DEFAULT_INTEREST_LIFETIME = time::milliseconds(4000);

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

  Interest();

  Interest(const Name& name);

  Interest(const Name& name, const time::milliseconds& interestLifetime);

  explicit
  Interest(const Block& wire);

  template<encoding::Tag TAG>
  size_t
  wireEncode(EncodingImpl<TAG>& encoder) const;

  const Block&
  wireEncode() const;

  void
  wireDecode(const Block& wire);

  bool
  hasWire() const
  {
    return m_wire.hasWire();
  }

  std::string
  toUri() const;

public: // Link and forwarding hint

  bool
  hasLink() const;

  const Link&
  getLink() const;

  void
  setLink(const Block& link);

  void
  unsetLink();

  bool
  hasSelectedDelegation() const;

  Name
  getSelectedDelegation() const;

  void
  setSelectedDelegation(const Name& delegationName);

  void
  setSelectedDelegation(size_t delegationIndex);

  void
  unsetSelectedDelegation();

public: // matching
  bool
  matchesName(const Name& name) const;

  bool
  matchesData(const Data& data) const;

public: // Name and guiders
  const Name&
  getName() const
  {
    return m_name;
  }

  Interest&
  setName(const Name& name)
  {
    m_name = name;
    m_wire.reset();
    return *this;
  }

  const time::milliseconds&
  getInterestLifetime() const
  {
    return m_interestLifetime;
  }

  Interest&
  setInterestLifetime(const time::milliseconds& interestLifetime)
  {
    m_interestLifetime = interestLifetime;
    m_wire.reset();
    return *this;
  }

  bool
  hasNonce() const
  {
    return m_nonce.hasWire();
  }

  uint32_t
  getNonce() const;

  Interest&
  setNonce(uint32_t nonce);

  void
  refreshNonce();

#ifdef NDN_LP_KEEP_LOCAL_CONTROL_HEADER
public: // local control header
  DEPRECATED(
  lp::LocalControlHeaderFacade
  getLocalControlHeader());

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

  DEPRECATED(
  uint64_t
  getIncomingFaceId() const);

  DEPRECATED(
  Interest&
  setIncomingFaceId(uint64_t incomingFaceId));

  DEPRECATED(
  uint64_t
  getNextHopFaceId() const);

  DEPRECATED(
  Interest&
  setNextHopFaceId(uint64_t nextHopFaceId));
#endif // NDN_LP_KEEP_LOCAL_CONTROL_HEADER

public: // Selectors
  bool
  hasSelectors() const
  {
    return !m_selectors.empty();
  }

  const Selectors&
  getSelectors() const
  {
    return m_selectors;
  }

  Interest&
  setSelectors(const Selectors& selectors)
  {
    m_selectors = selectors;
    m_wire.reset();
    return *this;
  }

  int
  getMinSuffixComponents() const
  {
    return m_selectors.getMinSuffixComponents();
  }

  Interest&
  setMinSuffixComponents(int minSuffixComponents)
  {
    m_selectors.setMinSuffixComponents(minSuffixComponents);
    m_wire.reset();
    return *this;
  }

  int
  getMaxSuffixComponents() const
  {
    return m_selectors.getMaxSuffixComponents();
  }

  Interest&
  setMaxSuffixComponents(int maxSuffixComponents)
  {
    m_selectors.setMaxSuffixComponents(maxSuffixComponents);
    m_wire.reset();
    return *this;
  }

  const KeyLocator&
  getPublisherPublicKeyLocator() const
  {
    return m_selectors.getPublisherPublicKeyLocator();
  }

  Interest&
  setPublisherPublicKeyLocator(const KeyLocator& keyLocator)
  {
    m_selectors.setPublisherPublicKeyLocator(keyLocator);
    m_wire.reset();
    return *this;
  }

  const Exclude&
  getExclude() const
  {
    return m_selectors.getExclude();
  }

  Interest&
  setExclude(const Exclude& exclude)
  {
    m_selectors.setExclude(exclude);
    m_wire.reset();
    return *this;
  }

  int
  getChildSelector() const
  {
    return m_selectors.getChildSelector();
  }

  Interest&
  setChildSelector(int childSelector)
  {
    m_selectors.setChildSelector(childSelector);
    m_wire.reset();
    return *this;
  }

  int
  getMustBeFresh() const
  {
    return m_selectors.getMustBeFresh();
  }

  Interest&
  setMustBeFresh(bool mustBeFresh)
  {
    m_selectors.setMustBeFresh(mustBeFresh);
    m_wire.reset();
    return *this;
  }

public: // EqualityComparable concept
  bool
  operator==(const Interest& other) const
  {
    return wireEncode() == other.wireEncode();
  }

  bool
  operator!=(const Interest& other) const
  {
    return !(*this == other);
  }

private:
  Name m_name;
  Selectors m_selectors;
  mutable Block m_nonce;
  time::milliseconds m_interestLifetime;

  mutable Block m_link;
  mutable shared_ptr<Link> m_linkCached;
  size_t m_selectedDelegationIndex;
  mutable Block m_wire;
};

std::ostream&
operator<<(std::ostream& os, const Interest& interest);

inline std::string
Interest::toUri() const
{
  std::ostringstream os;
  os << *this;
  return os.str();
}

} // namespace ndn

#endif // NDN_INTEREST_HPP