nack-header.cpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2025 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 Eric Newberry <enewberry@email.arizona.edu>
 */
 
#include "ndn-cxx/lp/nack-header.hpp"
#include "ndn-cxx/encoding/block-helpers.hpp"
 
namespace ndn::lp {
 
std::ostream&
operator<<(std::ostream& os, NackReason reason)
{
  switch (reason) {
  case NackReason::CONGESTION:
    return os << "Congestion";
  case NackReason::DUPLICATE:
    return os << "Duplicate";
  case NackReason::NO_ROUTE:
    return os << "NoRoute";
  default:
    return os << "None";
  }
}
 
bool
isLessSevere(lp::NackReason x, lp::NackReason y)
{
  if (x == lp::NackReason::NONE) {
    return false;
  }
  if (y == lp::NackReason::NONE) {
    return true;
  }
 
  return to_underlying(x) < to_underlying(y);
}
 
NackHeader::NackHeader(const Block& block)
{
  wireDecode(block);
}
 
template<encoding::Tag TAG>
size_t
NackHeader::wireEncode(EncodingImpl<TAG>& encoder) const
{
  size_t length = 0;
  length += prependNonNegativeIntegerBlock(encoder, tlv::NackReason, static_cast<uint64_t>(m_reason));
  length += encoder.prependVarNumber(length);
  length += encoder.prependVarNumber(tlv::Nack);
  return length;
}
 
NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS(NackHeader);
 
const Block&
NackHeader::wireEncode() const
{
  if (m_wire.hasWire()) {
    return m_wire;
  }
 
  EncodingEstimator estimator;
  size_t estimatedSize = wireEncode(estimator);
 
  EncodingBuffer buffer(estimatedSize, 0);
  wireEncode(buffer);
 
  m_wire = buffer.block();
  return m_wire;
}
 
void
NackHeader::wireDecode(const Block& wire)
{
  if (wire.type() != tlv::Nack) {
    NDN_THROW(ndn::tlv::Error("Nack", wire.type()));
  }
  m_wire = wire;
  m_wire.parse();
 
  m_reason = NackReason::NONE;
 
  auto it = m_wire.elements_begin();
  if (it != m_wire.elements_end()) {
    if (it->type() == tlv::NackReason) {
      m_reason = readNonNegativeIntegerAs<NackReason>(*it);
    }
    else {
      NDN_THROW(ndn::tlv::Error("NackReason", it->type()));
    }
  }
}
 
NackReason
NackHeader::getReason() const
{
  switch (m_reason) {
  case NackReason::CONGESTION:
  case NackReason::DUPLICATE:
  case NackReason::NO_ROUTE:
    return m_reason;
  default:
    return NackReason::NONE;
  }
}
 
NackHeader&
NackHeader::setReason(NackReason reason)
{
  m_reason = reason;
  m_wire.reset();
  return *this;
}
 
} // namespace ndn::lp